PPRO provides a set of intuitive, powerful, and flexible APIs. All endpoints accept and return JSON payloads and are designed around standard HTTP methods (GET, POST, etc..) for customer interactions. This section covers a few basic concepts on how to use our APIs.
Common API functionality
User Agent Header: With improved security, all API requests should now have the User-Agent header. This value should be the application / client making the call.
API Authentication: All APIs expect a Bearer Token for authentication. The access_token is obtained through the Authentication API.
HTTP Verbs: The APIs are designed to get as close as possible to standard HTTP and REST conventions with the use of HTTP verbs.
| Verb | Usage |
|---|---|
GET | Used to retrieve resources. |
POST | Used to add a child resource under resources collection, it is a non-idempotent operation also commonly used to retrieve tokens. |
PATCH | Used to partially update an existing resource, it is a non-idempotent operation. |