API 제출
아르고스 API를 이용하여 고객의 KYC 폼 데이터를 제출하고 KYC 진행 상황을 확인할 수 있습니다.
아르고스 API는 RESTful Endpoints와 기본인 HTTP Method를 사용합니다.
응답 데이터에는 요청 상태와 발생 가능한 오류 코드가 포함됩니다.
모든 응답 데이터는 JSON 형식으로 제공됩니다.
토큰 인증을 사용합니다.
모든 요청은 HTTPS에서 수행해야 합니다. HTTP 요청은 실패 됩니다.
1. API 키 확인
API를 이용하기 위해서는 유효한 API 키가 필요합니다. API키는 대시보드를 통해 확인 가능합니다.
2. 인증
API는 토큰에 기반한 인증을 이용합니다. API를 이용하기 위해서는 반드시 아르고스에서 제공한 API만 이용해야 합니다.
2-1. HTTP 헤더로 인증하기
쿼리와 함께 API 키를 HTTP 헤더로 보낼 수 있습니다.
API 키는 메소드 요청 헤더에 'x-api-key: {yourAPIKey}’로 포함되어야 합니다.
2-2. 오류
일반 HTTP 응답 코드로 응답합니다. 성공하면 2xx 코드로 표시됩니다. 4xx는 클라이언트에서 전송된 정보에 오류가 있을 때 발생하며, 5xx는 Argos 서버에서 오류가 있을 때 발생합니다.
오류코드
| HTTP 코드 | 메세지 | 설명 |
|---|---|---|
400 | Invalid Query String parameters | 클라이언트 에러 (예. 잘못된 형식의 요청 구문, 잘못된 요청 메시지 프레임) |
403 | User is not authorized to access this resource with an explicit deny | IP 화이트리스트에 등록되지 않은 IP로 접근을 시도할 때 |
403 | Forbidden | API 키 오류 |
413 | Request Entity Too Large | 요청이 서버가 의도하거나 수행할 수 있는 것보다 큽니다. |
500 | Internal Server Error | 아르고스 서버의 에러일 수 있습니다. 아르고스 팀에 문의하세요. |
502 | Bad Gateway | 서버가 업스트림 서버로부터 잘못된 응답을 받았습니다. |
3. API 할당량
API 키 별 초당 최대 요청 수: 5,000건 API 키 별 일일 최대 요청 수: 500,000건 (UTC 기준으로 00시에 리셋 됩니다.)
*Post와 Get을 합산합니다.
Last updated