개발자 문서 메뉴
API REFERENCE / LEGACY
REST API v1
기존 연동을 위한 API Secret Key 기반 인증 문서입니다. 새 프로젝트는 v2 가이드에서 시작하세요.
API 버전
토큰
REST API / v1 토큰
API Secret Key토큰
샌드고 API를 사용하기 위해 필요한 인증과 헤더 설정 방법입니다.
Token
토큰 정보를 담고 있는 객체입니다.
객체 상세
token
필수
·
string
expries_at
필수
·
string
토큰 발급
POST
/api/v1/token
샌드고의 모든 API 사용을 위해 필요한 액세스 토큰을 발급받기 위한 토큰 발급 API 입니다.
토큰의 유효기간은 1일이며, 발급 받은 후 1일이 지난 경우에 다시 발급받아야 합니다.
문자연동 정보나 사용자 정보가 변경된 경우에도 다시 발급 받아야 합니다.
※ 액세스 키와 시크릿 키 발급이 선행되어야 합니다.
액세스 키와 시크릿 키는 로그인 > 연동하기 > 연동정보에서 발급받을 수 있습니다.
발급 받은 액세스 키와 시크릿 키는 Header의 Authorization에 사용됩니다.
Authorization은 Basic Authentication 방식이며,
엑세스 키와 시크릿 키 사이에 :을 추가하고 base64로 인코딩하여
base64('엑세스 키:시크릿 키')로 만들어
Basic을 포함하고 Basic과 값 사이에 공백을 넣어야만 합니다.
Authorization: Basic {ENCODED_SECRET_KEY}
Content-Type: application/x-www-form-urlencoded
토큰의 유효기간은 1일이며, 발급 받은 후 1일이 지난 경우에 다시 발급받아야 합니다.
문자연동 정보나 사용자 정보가 변경된 경우에도 다시 발급 받아야 합니다.
※ 액세스 키와 시크릿 키 발급이 선행되어야 합니다.
액세스 키와 시크릿 키는 로그인 > 연동하기 > 연동정보에서 발급받을 수 있습니다.
발급 받은 액세스 키와 시크릿 키는 Header의 Authorization에 사용됩니다.
Authorization은 Basic Authentication 방식이며,
엑세스 키와 시크릿 키 사이에 :을 추가하고 base64로 인코딩하여
base64('엑세스 키:시크릿 키')로 만들어
Basic을 포함하고 Basic과 값 사이에 공백을 넣어야만 합니다.
Authorization: Basic {ENCODED_SECRET_KEY}
Content-Type: application/x-www-form-urlencoded
Response
성공
토큰 발급에 성공하면 Token 객체가 돌아옵니다. 토큰은 24시간 유효합니다.
실패
토큰 발급에 실패했다면 HTTP 상태 코드와 함께 에러 객체가 돌아옵니다.
크레딧 조회 API에서 발생할 수 있는 에러를 살펴보세요.
크레딧 조회 API에서 발생할 수 있는 에러를 살펴보세요.
PHP
<?php
$url = "https://sendgo.io/api/v1/token";
$access_key = 'access_key';
$secret_key = 'secret_key';
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $url,
CURLOPT_HTTPHEADER => [
'Authorization: Basic ' . base64_encode($access_key . ':' . $secret_key),
'Content-Type: application/x-www-form-urlencoded'
],
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}응답 예제
JSON
{
"token": "MjB8M2NjYjI1YzRiNzY1Y2ExMTIxZDZhMGQ5NDdlY2RhNTQuMDJjOTRhNWIwODU2",
"expires_at": "2024-09-04T07:28:21.148947Z"
}만드는 일에 집중하세요. 메시지는 샌드고가.맨 위로 ↑