시작하기

Overview

Add On API를 이용하여 고객의 데이터를 제출하고 진행 상황을 확인할 수 있습니다. 아르고스 API는 RESTful Endpoints와 기본인 HTTP Method를 사용합니다.

• 응답 데이터에는 요청 상태와 발생 가능한 오류 코드가 포함됩니다.

• 모든 응답 데이터는 JSON 형식으로 제공됩니다.

• 토큰 인증을 사용합니다.

• 모든 요청은 HTTPS에서 수행해야 합니다. HTTP 요청은 실패 됩니다.

Getting Started

API를 이용하기 위해서는 유효한 전용 API 키가 필요합니다. API 키는 대시보드의 KYC 프로젝트 내 Add On 프로젝트에서 확인할 수 있습니다. Live form 을 사용하지 않고 API로 를 제출할 경우 POS를 확인해 주세요.

Authentication

API는 토큰에 기반한 인증을 이용합니다. API를 이용하기 위해서는 반드시 아르고스에서 제공한 전용 API 키를 이용해야 합니다.

HTTP 헤더로 인증하기

쿼리와 함께 API 키를 HTTP 헤더로 보내야 합니다. API 키는 메소드 요청 헤더에 'x-api-key: {yourAPIKey}’로 포함되어야 합니다.

curl -H "x-api-key: {yourAPIKey}" "https://rest-api.argoskyc.com/..."

API Gateway Error

일반 HTTP 응답 코드로 응답합니다. 성공하면 2XX 코드, 4XX는 클라이언트에서 전송된 정보에 오류가 있을 때 발생하며, 5XX는 아르고스 서버에서 오류가 있을 때 발생합니다.

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건 (UTC 기준으로 00시에 리셋 됩니다.)