잽페이 API를 사용하기 위해 필요한 인증과 헤더 설정 방법입니다.
인증 헤더
잽페이 API는 일반적으로 Basic 인증에 시크릿 키를 사용합니다. API 요청에서 시크릿 키는 서버가 클라이언트의 신원을 확인하기 위해 사용하는 중요한 정보입니다. 클라이언트는 요청 시 헤더에 시크릿 키를 포함하며, 서버는 이를 미리 제공된 값과 비교해 요청의 신뢰성을 확인합니다.
HTTP Basic 인증 방식은 클라이언트에서 base64로 인코딩된 사용자 ID, 비밀번호 쌍을 인증 정보(credentials) 값으로 사용합니다. 사용자 ID와 비밀번호는 아래와 같이 콜론으로 구분합니다. Base64로 인코딩한 정보는 쉽게 디코딩이 가능해서 Basic 인증은 반드시 HTTPS 및 TLS와 함께 사용해야 합니다.
Authorization: Basic base64({USERNAME}:{PASSWORD})
JSON
복사
시크릿 키로 인증하기
1.
Product의 시크릿 키는 추후 잽페이에서 제공될 예정입니다. 현재는 아래 임시 테스트 시크릿 키를 사용해 주시면 됩니다.
test_sk_11d1dbd39b55ce66432ca7c077b3e0c1
Plain Text
복사
test_sk로 시작하는 시크릿 키는 테스트 키입니다. live_sk로 시작하는 시크릿 키는 라이브 키입니다. 시크릿 키는 외부에 절대 노출되면 안 됩니다.
2.
시크릿 키 뒤에 :을 추가하고 base64로 인코딩하세요. 콜론을 빠트리지 않도록 주의하세요. 잽페이 API는 시크릿 키를 사용자 ID로 사용하고, 비밀번호는 사용하지 않습니다. 비밀번호가 없다는 것을 알리기 위해 시크릿 키 뒤에 콜론을 추가합니다.
echo -n 'test_sk_11d1dbd39b55ce66432ca7c077b3e0c1:' | base64
JSON
복사
3.
인코딩된 값을 API의 Basic 인증헤더에 사용하세요.
Authorization: Basic {ENCODED_SECRET_KEY}
JSON
복사
에러 처리하기
HTTP Status Code | 에러 코드 | 메시지 |
403 | INVALID_SECRET_KEY | 시크릿키가 유효하지 않습니다. |
미디어 타입 헤더
잽페이는 API 요청에서 Content-Type: application/json 헤더를 사용하여 요청 본문이 JSON 형식으로 전송됨을 명시합니다. 이를 통해 서버는 요청 데이터를 JSON 형식으로 처리할 수 있습니다.
1.
아래 내용을 헤더에 포함해주세요.
Content-Type: application/json
JSON
복사