인증

박스히어로 API 요청은 Bearer 토큰으로 인증하고, 버전이 붙은 기본 URL로 보냅니다.

API 토큰

모든 요청에는 Authorization 헤더에 Bearer 토큰 형식으로 API 토큰을 담아야 합니다.

Authorization: Bearer <api-token>

API 토큰은 박스히어로 앱의 설정 > 연동 설정에서 발급합니다. 토큰은 하나의 팀에 연결되며, 모든 요청은 그 팀의 데이터만 조회하고 변경합니다. 여러 팀을 연동하려면 팀마다 토큰을 발급해 주세요.

토큰 없이 호출할 수는 없습니다. 토큰이 없거나 유효하지 않으면 모든 엔드포인트가 401과 오류 응답을 반환합니다.

기본 URL과 버전

모든 요청은 아래 주소로 보냅니다.

https://rest.boxhero-app.com

모든 엔드포인트는 /v1 경로 아래에 있습니다. 예: GET /v1/items

팀 모드

대부분의 엔드포인트는 위치별로 재고를 관리하는 팀에서만 사용할 수 있습니다. 그 외의 팀에서는 400과 함께 /errors/invalid-team-mode 유형의 오류가 반환됩니다. 팀, 멤버, 거래처, 속성 엔드포인트는 모든 팀에서 사용할 수 있으며, Get the linked team을 호출하면 팀의 모드를 확인할 수 있습니다.