Authentication
딜리버리 트래커 API들을 사용하기 위해서는 아래 두 방법 중 하나를 선택하여 인증하여야 합니다.
Method 1. API Key (Recommended)
Step 1. Delivery Tracker Console 에서 Credentials 를 가져옵니다.
Delivery Tracker Console 에서 프로젝트의 Credentials 을 가져옵니다.
프로젝트 생성 및 Credentials 생성 방법은 본 문서 하단의 Console 을 사용하여 Credentials 생성 항목을 참고해주세요.
Step 2. API 에 액세스 토큰 보냅니다.
Step 2에서 획득한 Access Token 을 사용하여 아래와 같이 사용하고자 하는 API 를 호출 합니다.
Request
POST https://apis.tracker.delivery/graphql
Authorization: TRACKQL-API-KEY [YOUR_CLIENT_ID]:[YOUR_CLIENT_SECRET]
Content-Type: application/json
{"query": "query AuthTestQuery { carriers(first: 10) { edges { node { id name } } } }"}
Request Header 의 [YOUR_CLIENT_ID], [YOUR_CLIENT_SECRET] 를 Console 을 사용하여 Credentials 생성을 통해 획득한 Client Id, Client Secret로 대체하여야 합니다.
2024-05-13 이전에 등록된 Client ID는 API Key로 사용할 수 없으며, oauth2 방식만 제공합니다. API Key 사용을 위해 새로운 Credentials를 생성하여 주십시오.
Method 2. OAuth2 Access Token
Step 1. Delivery Tracker Console 에서 Credentials 를 가져옵니다.
Delivery Tracker Console 에서 프로젝트의 Credentials 을 가져옵니다.
프로젝트 생성 및 Credentials 생성 방법은 본 문서 하단의 Console 을 사용하여 Credentials 생성 항목을 참고해주세요.
Step 2. Delivery Tracker 인증 서버로부터 액세스 토큰 가져옵니다.
Delivery Tracker 인증 서버는 OAuth 2.0 Client Credentials 표준을 준수 합니다.
Step 1 과정을 통해 획득한 Credentials 정보를 이용하여 다음과 같이 HTTP Request를 전송하여 Access Token 을 생성 합니다.
Request
POST https://auth.tracker.delivery/oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=[YOUR_CLIENT_ID]&client_secret=[YOUR_CLIENT_SECRET]
Request Body 의 [YOUR_CLIENT_ID], [YOUR_CLIENT_SECRET] 를 Credentials 정보 (Client ID, Client Secret) 로 대체하여야 합니다.
Response
{
"access_token": "[YOUR_ACCESS_TOKEN]",
...
}