API

박스히어로 공개 API에 관한 자주 묻는 질문입니다.

---

API Token 발급은 어디서 하나요?

PC web 버전에서 해당 팀에 접속한 후, 설정 > 연동 설정 메뉴에서 생성할 수 있습니다.

목록 조회 시 일부 항목만 조회되는 경우

목록 조회 API는 대상 자원의 양이 많아질 수 있는 경우(예: 제품 목록, 트랜잭션 목록) 페이지네이션을 통해 한 번의 요청으로 반환되는 항목 수를 제한합니다. 저희 API는 커서 기반 페이지네이션 방식을 사용하고 있으며, 다음 페이지의 목록을 조회하려면 아래와 같은 방법을 참고해 주세요.

페이지네이션 필요 여부는 API 문서 중 해당 엔드포인트의 요청 본문에 페이지네이션 관련 매개변수들이(has_more, cursor) 존재하는지 여부로 판단해 주시면 됩니다.

1. 페이지네이션 정보 확인

   • 페이지네이션이 필요한 목록 조회 API 응답에는 has_more와 cursor 필드가 포함되어 있습니다.\ - has_more 필드는 현재 페이지 이후에도 추가 데이터가 있는지 여부를 boolean 값으로 나타냅니다.\ - cursor 필드는 다음 페이지를 요청할 때 필요한 커서 값을 제공합니다.

2. 다음 페이지 조회

   • has_more 값이 true인 경우 추가 페이지가 존재하는 것으로, 다음 페이지를 조회하려면 기존 요청의 파라미터에 cursor={응답받은 커서값}을 추가하여 요청해 주세요. 이렇게 하면 후속 데이터를 반환받을 수 있습니다.

3. 전체 목록 조회

   • 전체 목록을 조회하려면 위 과정을 has_more가 false가 될 때까지 반복해 주세요.

API 호출 제한이 있나요?

안정적인 서비스 운영을 위해 각 API 엔드포인트는 초당 5회까지 요청할 수 있습니다. 제한을 초과하면 Rate Limit 관련 헤더와 함께 오류 응답이 반환됩니다.

원하는 답변을 찾지 못하셨다면 고객센터로 문의해 주세요.