# 아르고스 API
Argos API를 이용하여 KYC form 데이터를 제출하고, KYC 진행 상태 및 결과 또는 제출 데이터를 조회할 수 있습니다.
Argos API 는 RESTful Endpoints 와 기본 HTTP Method를 사용합니다.
- 응답 데이터는 요청 상태와, 있을수 있는 오류 코드를 포함하고 있습니다.
- 모든 응답 데이터는 JSON 포맷으로 구성되어 있습니다.
- 토큰 방식의 인증을 사용합니다.
- 모든 요청은 HTTPS 로 이루어 져야 합니다. HTTP 방식의 요청은 실패합니다.
# 인증
API는 토큰 기반의 인증 방식을 사용합니다.
아르고스 고객지원팀으로부터 제공된 API 키를 이용해야 API 를 사용할 수 있습니다.
API 키는 요청 헤더에 'x-api-key: hTRgZTc6UR2FLgIh5tKLsyjO89xBsiWG3pz3eYvc‘와 같은 방식으로 포함되어야 합니다.
예시
curl -H "x-api-key:hTRgZTc6UR2FLgIh5tKLsyjO89xBsiWG3pz3eYvc" https://api2.argos-solutions.io/f1/submissions
# 오류 형식
오류 발생시 일반 HTTP 코드로 응답됩니다. 성공인 경우 2xx 코드로 표현됩니다. 4xx 코드는 클라이언트가 전송한 정보에 문제가 있는 경우 발생합니다. 아르고스 서버에 문제가 있는 경우 5xx 코드로 응답됩니다.
| HTTP 코드 | 메시지 | 설명 |
|---|---|---|
| 400 | Invalid Query String parameters | 유효하지 않은 데이터가 Query String으로 제출되었을 경우 (잘못 입력한 요청 구문이나 유효하지 않은 데이터가 제출되었는지 확인해야 합니다.) |
| 403 | Forbidden | API 키를 입력하지 않았거나 유효하지 않은 API 키를 입력한 경우 |
| 413 | Request Entity Too Large | 업로드 된 파일의 용량에 문제가 있는 경우 |
| 500 | Internal Server Error | 기타 서버 에러 |
| 502 | Bad Gateway | 게이트웨이 연결 문제로 유효하지 않은 응답을 전송받은 경우 |