시작하기

1. 사용자 등급

모든 서비스는 회원가입 진행 후 사용 가능합니다. 별도 설정 없이도 FREE 등급으로 서비스를 사용하실 수 있습니다.

등급	사용제한
FREE	일 100건 무료 사용
PREMIUM	일 무제한 사용

2. API Key 발급 및 API 요청

CANDiY API를 사용하기 위해 API 키를 발급 받아야 합니다.
사용자 대시보드의 API Key 관리 화면에서 발급이 가능하고, 사용자는 여러개의 키를 발급받을 수 있으며, 각 키당 사용할 서비스를 선택해 발급하실 수 있습니다.

이후, 발급받은 API 키를 모든 Rest API 요청 헤더에 포함하여 요청을 보내야 합니다.

Example

service_name에 사용하고자 하는 서비스의 endpoint (경로)로 대체하고, your_api_key자리에 사용자의 API Key를 입력합니다. "data"가 적혀있는 부분에 요청에 필요한 값을 적어주면, 서비스를 호출할 수 있습니다.

3. 데이터 응답값

API 요청 결과 (response) 데이터는 status와 data로 구성되어 있습니다.
status에는 API의 응답 상태를 나타내고, data에는 요청한 API 서비스의 데이터가 담깁니다.

Key	Name	Description
status	API 응답 상태	성공 시: "success" 실패/에러 발생 시: "error"
data	API 결과	서비스마다 형식과 값이 다르며, 같은 서비스 내 endpoint마다 필수 파라미터가 다릅니다. * API 상품별 요청 값은 API 문서를 확인하세요.

성공 응답 예제

실패 응답 예제

4. 추가인증

추가 인증은 각 기관에서 보안 향상을 위해 사용하는 방법입니다.
기관에서 추가 인증을 요구하는 상품은 Candiy API 사용 시에도 추가 인증을 해야 합니다. 기본 추가인증을 요구하는 제한시간은 약 3분이며 상품별로 제한시간을 요청하는 경우 해당 제한 시간이 추가인증 요청 제한 시간으로 설정됩니다.