시작하기
라이브폼 URL 사용하기
아르고스는 프로젝트 각각의 고유한 제출 페이지인 라이브폼을 URL 형태로 제공합니다. 이 URL은 대시보드에서 확인할 수 있습니다.
라이브폼을 이용하여 KYC를 진행하기로 한 경우에는 두 가지 방식으로 이용할 수 있습니다.
첫 번째로 서비스가 PC에서 진행되는 경우 라이브폼 URL을 열면 QR코드가 나옵니다. 사용자가 모바일 기기로 QR코드를 스캔하면, 모바일 웹 브라우저에서 라이브폼이 열립니다.
서비스가 모바일에서 진행이 되는 경우 모바일 기기에서 바로 URL을 열어주세요. 웹 브라우저에서 라이브폼이 열립니다.
*프론트 페이지를 직접 구축하고 API방식을 통해 KYC를 제출하는 경우 API제출 페이지를 참고해주세요.
Overview
아르고스 API를 이용하여 고객의 KYC 폼 데이터를 제출하고 KYC 진행 상황을 확인할 수 있습니다. 아르고스 API는 RESTful Endpoints와 기본인 HTTP Method를 사용합니다.
응답 데이터에는 요청 상태와 발생 가능한 오류 코드가 포함됩니다.
모든 응답 데이터는 JSON 형식으로 제공됩니다.
토큰 인증을 사용합니다.
모든 요청은 HTTPS에서 수행해야 합니다. HTTP 요청은 실패 됩니다.
Authentication
API를 이용하기 위해서는 유효한 API 키가 필요합니다. API 키는 대시보드에서 확인할 수 있습니다.
API는 토큰에 기반한 인증을 이용합니다.
HTTP 헤더로 인증하기
쿼리와 함께 API 키를 HTTP 헤더로 보내야 합니다. API 키는 메소드 요청 헤더에 'x-api-key: {yourAPIKey}’로 포함되어야 합니다.
API Gateway Error
HTTP Code | Message | Description |
400 | Invalid Query String parameters | 클라이언트 에러 (예. 잘못된 형식의 요청 구문, 잘못된 요청 메시지 프레임 |
403 | User is not authorized to access this resource with an explicit deny | 프로젝트에서 IP에 액세스할 수 없으면 요청이 차단됩니다. |
403 | Forbidden | API 키가 제공되지 않았거나 API 키에 문제가 있습니다. |
413 | Request Entity Too Large | 요청이 서버가 의도하거나 수행할 수 있는 것보다 큽니다. |
500 | Internal Server Error | 아르고스 서버의 에러일 수 있습니다. 아르고스 팀에 문의하세요. |
502 | Bad Gateway | 서버가 업스트림 서버로부터 잘못된 응답을 받았습니다. |
API 할당량 (Request Limit)
초당 최대 요청 수: 5,000건
일일 최대 요청 수: 500,000건
Last updated
