빠른 시작

API 토큰을 발급하고 박스히어로 API에 첫 요청을 보냅니다.

API 토큰 발급부터 첫 API 호출 성공까지의 과정을 안내합니다.

1. API 토큰 발급

PC 웹 버전에서 연동할 팀에 접속한 후, 설정 > 연동 설정 메뉴에서 새 API 토큰을 생성하고 복사해 주세요.

2. 첫 요청 보내기

Get the linked team을 호출해 토큰이 정상적으로 동작하는지 확인합니다. 토큰은 Authorization 헤더에 담아 보냅니다.

curl https://rest.boxhero-app.com/v1/teams/linked \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"

응답으로 토큰이 연결된 팀의 정보가 반환됩니다.

{
  "id": 149058,
  "name": "Acme Retail",
  "mode": 2,
  "currency_symbol": "$",
  "currency_code": "USD",
  "price_decimal_places": 2,
  "memo": null
}

401이 반환된다면 토큰이 없거나 일부만 복사된 경우입니다. 오류 형식은 오류를 참고해 주세요.

3. 다음 단계

List items로 제품 목록을 조회하고, 모든 페이지를 가져오는 방법은 페이지네이션에서 확인해 보세요.
Create a transaction으로 입출고를 기록할 수 있습니다. 규칙은 입출고를 참고해 주세요.
주기적으로 조회하는 대신 웹훅으로 변경 사항을 받아 보세요.
전체 엔드포인트는 API 레퍼런스에서 확인할 수 있습니다.