테스트 하기

이메일로 아르고스 ID를 인증하는 방법을 보다 잘 이해할 수 있도록 포스트맨으로 테스트하는 방법에 대해 알아보겠습니다.

1. 사전 준비

1-1. API 키 발급받기

가장 먼저는 API 키가 필요합니다. 아르고스 ID 대시보드에 접속해 회원가입을 하고, 프로젝트를 생성해 API 키를 발급받아야 합니다. API 키를 확인하는 자세한 방법은 대시보드 이용 가이드Project Info 페이지를 참고해 주세요.

1-2. 포스트맨 준비하기

아래 링크에 접속해 PC에 포스트맨을 설치하거나 웹페이지에서 접속해주세요.

포스트맨 다운로드 링크

https://www.postman.com/downloads

2. 테스트 하기

1 - 3. 리퀘스트 생성

포스트맨을 실행했으면 +버튼을 눌러 새로운 리퀘스트를 생성해 주세요. 타입을 'GET'에서 'POST'로 바꾸고, URL 란에 아래의 주소를 붙여 넣어주세요.

https://rest-api.argoskyc.com/v3/idverify

4 ~ 6. API 키 입력

'Headers'탭으로 이동하여 'x-api-key'라는 Key를 입력해서 생성하고, Value 칸에는 테스트를 진행하고자 하는 프로젝트의 API 키를 붙여 넣어주세요.

7 ~ 11. API 요청

다음으로는 'Body'탭으로 이동해서 데이터 타입을 'form-data'로 체크하고, 필요한 키와 밸류를 입력한 뒤 'Send'버튼을 누르면 API 요청이 완료됩니다. Key에 들어갈 수 있는 데이터는 이메일로 인증하기 - Input Data 페이지를 참고 부탁드리며, 그중 'email'만 필수 값입니다.

3. 결과 확인하기

POST 요청이 완료되면 결과를 확인할 수 있습니다.

정상적으로 요청이 완료된 경우 '이메일이 성공적으로 발송되었습니다(The email has been sent successfully.)'라는 메시지가 리턴됩니다.

실패 시에는 원인에 따라 메시지가 달라질 수 있습니다. 권한(access, authorized) 관련 메시지가 리턴되면 API 키가 정확한 지 다시 한번 확인해 주세요.

Last updated