Every request needs two things: an API token to authenticate, and your profile ID to say which merchant profile you're working on. Get both before you do anything else.
Get your API token
- In the BillPro dashboard, open the profile menu and go to Users.
- Select the user your integration will act as. It must be an Admin user: only Admins can use the API.
- Copy the token from the API Token section.
- Send it as a Bearer token in the
Authorizationheader of every request:
--header 'Authorization: Bearer {api_token}' \The API Token section only appears when the user has API Access. Only Admin users can have it. To turn on API Access, contact BillPro.
Find your profile ID
Every endpoint path includes your profile ID: /api/v2/profiles/{profile_id}/....
Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.
If you work with more than one merchant profile, each has its own ID. Use the one the request is for.
Good to know
- API tokens don't expire. Treat them like a password.
- Only use them from your server. Never put them in a browser or mobile app.
- A token only works while its user is active and has API Access. Otherwise, every request returns
401. - Use a dedicated integration user for each merchant profile. You can trace and revoke its access without affecting anyone else.
- Customers don't need a token. They pay from the link you send them.
Next
Continue to 2 · Build your catalog.