사용 준비
호출할 API 정보를 개발팀에게 받고, 인증이 필요한 API라면 인증 정보를 등록합니다.
1단계. 호출할 API 준비하기
Section titled “1단계. 호출할 API 준비하기”아래 네 가지를 개발팀에게 받아두세요. 개발팀에는 API 연동 가이드 페이지를 함께 공유해주세요.
| 받아둘 것 | 어디에 쓰나 | 예시 |
|---|---|---|
| API 주소 | 지시문에 그대로 입력합니다 | https://api.example.com/points |
| 요청 방식 | GET인지 POST인지에 따라 작성법이 달라집니다 | GET |
| 인증 방식 | 인증이 필요하면 2단계에서 등록합니다 | Basic 또는 Token, 없으면 불필요 |
| 응답 예시(JSON) | 어떤 필드를 메시지에 쓸 수 있는지 확인합니다 | {"amount": 12000, "expires_at": "2026-09-30"} |
2단계. 인증 정보 등록하기
Section titled “2단계. 인증 정보 등록하기”인증 없이 호출할 수 있는 API라면 이 단계는 건너뛰세요.
인증이 필요한 API는 ID나 토큰을 메시지에 직접 적지 않고, 먼저 등록한 뒤 메시지에서는 이름으로만 불러옵니다.
인증 정보 섹션 열기
Section titled “인증 정보 섹션 열기”설정 › 프로젝트에서 인증 정보를 프로젝트 당 최대 10개까지 등록할 수 있습니다.
인증 방식 선택하고 입력하기
Section titled “인증 방식 선택하고 입력하기”개발팀에서 받은 인증 방식에 따라 Basic 또는 Token을 선택합니다.
| 인증 방식 | 이럴 때 선택하세요 | 입력 항목 |
|---|---|---|
| Basic | ID와 비밀번호로 인증하는 API | 인증 이름, ID, PW, 허용 도메인 |
| Token | Authorization: Bearer ...처럼 헤더로 인증하는 API | 인증 이름, 헤더명, 헤더값, 허용 도메인 |
- 인증 이름은
stock_api처럼 어떤 API인지 알아볼 수 있게 지어주세요. - 허용 도메인은 호출 주소의 도메인과 정확히 일치할 때만 사용됩니다. 하위 도메인도 인정하지 않습니다.
| 등록한 도메인 | 호출 주소 | 사용 가능 여부 |
|---|---|---|
api.example.com | https://api.example.com/stock | 사용됨 |
api.example.com | https://other.example.com/stock | 사용 안 됨 |
api.example.com | https://shop.api.example.com/stock | 사용 안 됨 |
이름 복사해두기
Section titled “이름 복사해두기”리스트에서 인증 이름 왼쪽의 복사 버튼을 누르면, 메시지에 바로 붙여 넣을 수 있는 형태로 복사됩니다.
