Spotify API

Part 3. API는 무엇인가

본 포스팅은 패스트캠퍼스(FastCampus)의 데이터 엔지니어링 올인원 패키지 Online을 참고하였습니다.

1. Spotify App 생성 및 토큰 발급

Client Credentials Flow

1
2
3
4
5


{
   "access_token": "NgCXRKc...MzYjw",
   "token_type": "bearer",
   "expires_in": 3600,
}

client id, client secret을 제공하면 우리는 3600초, 즉 1시간동안 사용할 수 있다.

2. Python 기본

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


import sys

def main():
    print('fastcampus')

#python으로 실행했을 때, 해당 py파일 이름이 전달되면, main()을 실행하라
if __name__ == '__main__':
    main()
#직접 py파일이 실행 안되고, import spotify_api와 같이 모듈처럼 import되면, ~~를 print하라.
else:
    print('this script i being imported')

Windows는 Windows Powershell을 통해서 진행하면 된다.
기본적으로 위처럼 코딩을 시작하게 된다.

3. Python Requests 패키지

requests python library > Developer Interface 참고하기
powershell에서 pip install requests 실행하기

4. API를 통한 데이터 요청

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52


import sys
import requests
import base64
import json
import logging

client_id = '' # client_id 입력
client_secret = '' # client_secret 입력

def main():
    headers = get_headers(client_id, client_secret)
    params = {
        'q': 'BTS',
        'type': 'artist',
        'limit': 5
    }

    r = requests.get('https://api.spotify.com/v1/search', params=params, headers=headers)
    # print(r.status_code) # 200이면 이상 없는 것
    # print(r.text)
    # sys.exit(0)

def get_headers(client_id, client_secret):
    # 1시간만 있으면 expire되기 때문에 추가로 function 하나를 만들어두는 것이다.
    endpoint = 'https://accounts.spotify.com/api/token'
    encoded = base64.b64encode("{}:{}".format(client_id, client_secret).encode('utf-8')).decode('ascii')

    headers = {
        'Authorization': 'Basic {}'.format(encoded)
    }

    payload = {
        'grant_type': 'client_credentials'
    }

    r = requests.post(endpoint, data=payload, headers=headers)
    # 중간에 잘 되는지 확인해보는 코드
    # print(r.status_code)
    # print(r.text)
    # print(type(r.text)) #string으로 출력되므로 아래에서 json.loads를 통해 dictionary로 만들어줘야 한다.
    # sys.exit(0)

    access_token = json.loads(r.text)['access_token']
    headers = {
        'Authorization': "Bearer {}".format(access_token)
    }

    return headers

if __name__ == '__main__':
    main()

5. Status Code

Status Code를 알아야 하는 이유: 데이터 엔지니어의 잘못이 아닌, Spotify 서버의 오류 등으로 인한 문제인지 체크할 수 있다.
Spotify Web API 기준이지만, RFC 2616와 RFC 6585에 의해 일반적으로 통용되는 기준이다.

STATUS CODE	DESCRIPTION
200	`OK` - The request has succeeded. The client can read the result of the request in the body and the headers of the response.
201	`Created` - The request has been fulfilled and resulted in a new resource being created.
202	`Accepted` - The request has been accepted for processing, but the processing has not been completed.
204	`No Content` - The request has succeeded but returns no message body.
304	`Not Modified.` See Conditional requests.
400	`Bad Request` - The request could not be understood by the server due to malformed syntax. The message body will contain more information; see Response Schema.
401	`Unauthorized` - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.
403	`Forbidden` - The server understood the request, but is refusing to fulfill it.
404	`Not Found` - The requested resource could not be found. This error can be due to a temporary or permanent condition.
429	`Too Many Requests` - Rate limiting has been applied.
500	`Internal Server Error.` You should never receive this error because our clever coders catch them all … but if you are unlucky enough to get one, please report it to us through a comment at the bottom of this page.
502	`Bad Gateway` - The server was acting as a gateway or proxy and received an invalid response from the upstream server.
503	`Service Unavailable` - The server is currently unable to handle the request due to a temporary condition which will be alleviated after some delay. You can choose to resend the request again.

6. 에러 핸들링

sys.exit(0)과 sys.exit(1) 차이

1
2
3
4


# 프로그램을 정상적으로 종료시키고 싶을 때
sys.exit(0)
# 프로그램을 강제적으로 종료시키고 싶을 때
sys.exit(1)

Status Code 401, 409 에러 핸들링

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


r = requests.get('https://api.spotify.com/v1/search', params=params, headers=headers)
if r.status_code != 200:
    logging.error(r.text)

    ## Too many requests
    if r.status_code == 429:
        retry_after = json.loads(r.headers)['Retry-After']
        time.sleep(int(retry_after))

        r = requests.get('https://api.spotify.com/v1/search', params=params, headers=headers)

## access_token expireed
elif r.status_code == 401:
    headers = get_headers(client_id, client_secret)
    r = requests.get('https://api.spotify.com/v1/search', params=params, headers=headers)

else:
    sys.exit(1) #강제종료

7. 페이지네이션 핸들링

참고사이트

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50


import sys
import requests
import base64
import json
import logging

client_id = '' # client_id 입력
client_secret = '' # client_secret 입력

def main():
    headers = get_headers(client_id, client_secret)

    # Get BTS' Albums
    r = requests.get('https://api.spotify.com/v1/artists/3Nrfpe0tUJi4K4DXYWgMUX/albums', headers=headers)
    raw = json.loads(r.text)

    # total = raw['total'] # 총 104개가 있음을 확인
    # offset = raw['offset'] # 시작은 0
    # limit = raw['limit'] # 20개씩 뽑겠다.
    next = raw['next']

    albums = []
    albums.extend(raw['items'])

    ## 난 200개만 뽑아 오겠다.
    count = 0
    while count < 200 and next: # while next: 라고만 하면 끝까지 가져오게 된다.
        r = requests.get(raw['next'], headers=headers)
        raw = json.loads(r.text)
        next = raw['next']
        # print(next) # 맨 마지막에는 none이 나오게 된다. 이에 대해서는 Spotify 페이지를 참고하면 된다.
        albums.extend(raw['items'])
        count = len(albums)
    print(len(albums))

def get_headers(client_id, client_secret):
    endpoint = 'https://accounts.spotify.com/api/token'
    encoded = base64.b64encode("{}:{}".format(client_id, client_secret).encode('utf-8')).decode('ascii')

    headers = {'Authorization': 'Basic {}'.format(encoded)}
    payload = {'grant_type': 'client_credentials'}

    r = requests.post(endpoint, data=payload, headers=headers)
    access_token = json.loads(r.text)['access_token']
    headers = {'Authorization': "Bearer {}".format(access_token)}

    return headers

if __name__ == '__main__':
    main()

Spotify API

Spotify API

Part 3. API는 무엇인가

1. Spotify App 생성 및 토큰 발급

Client Credentials Flow

2. Python 기본

3. Python Requests 패키지

4. API를 통한 데이터 요청

5. Status Code

6. 에러 핸들링

sys.exit(0)과 sys.exit(1) 차이

Status Code 401, 409 에러 핸들링

7. 페이지네이션 핸들링

목차