Getting started
Get your API key and make your first onboarding call
You use onboarding to set up businesses on the Priority Commerce Engine (PCE).
Before you begin
Make sure you have the following in place before your first call:
| Item | Description |
|---|---|
| Access | Contact Priority support to get access to the onboarding API. |
| API key | Send your API key in the x-api-key header on every request: x-api-key: <your-key>. Contact Priority support to get sandbox and production keys. |
| Base URLs |
|
| HTTPS | Send every request over HTTPS. |
API basics
| Action | Method | What happens |
|---|---|---|
| Create | POST | Returns 201 Created with the new record's id and uri. |
| Read | GET | Returns the record. Add ?expand=true on a business to get its full details. See Query Parameters. |
| Update | PATCH | Changes only the fields you send. Services are turned on and off with PATCH. |
PCE creates every ID. Store the IDs it returns. For what each ID prefix means, see Businesses.
API conventions
The cross-cutting conventions live on their own pages.
Next steps
See also
- Businesses: the entity model and vocabulary
- Status lifecycle: how a business moves from creation to live
- API error handling: validation and error responses
Updated 9 days ago
Did this page help you?