Lewati ke konten

Autentikasi

Autentikasi permintaan BoxHero API dengan token Bearer dan kirimkan ke URL dasar berversi.

Setiap permintaan harus menyertakan token API sebagai token Bearer di header Authorization:

Authorization: Bearer <api-token>

Terbitkan token di aplikasi BoxHero melalui Pengaturan > Integrasi. Setiap token terikat ke satu tim: setiap permintaan hanya membaca dan menulis data tim tersebut. Untuk bekerja dengan beberapa tim, terbitkan token di masing-masing tim.

Akses anonim tidak didukung. Jika token tidak ada atau tidak valid, setiap endpoint mengembalikan 401 dengan amplop error.

Semua permintaan dikirim ke:

https://rest.boxhero-app.com

Setiap endpoint berada di bawah prefiks /v1 — misalnya, GET /v1/items.

Sebagian besar endpoint hanya tersedia untuk tim yang mengelola stok berdasarkan lokasi. Untuk tim lain, endpoint tersebut mengembalikan 400 dengan tipe error /errors/invalid-team-mode. Endpoint tim, anggota, partner, dan atribut berfungsi untuk semua tim — panggil Ambil tim yang terhubung untuk melihat mode yang digunakan tim Anda.