The headless Approvals API service enables rapid experience-first commerce and application development. The Approvals API, built on a JSON Open API specification, follows a microservice architecture that enables commerce into any part of an application, follows predictable REST URLs, and supports cross-origin resource sharing.
Authentication
All requests to the API must be accompanied by an authorization header with an authentication token.
Authorization: Bearer 00D230000000nZM!ARMAQHLLm33JxYYP.UJn1gF6FFmLv8sDYK_8szeckHWtbguztoBpF0HL8... |
This token is accessible through the standard Conga authentication interface. Depending on the product and configuration, your token may be managed by Salesforce's or Microsoft's identity management service.
Endpoint
The Approvals API is installed with the package and can be exposed to external applications via a Salesforce site or community.
https://<Instance_URL>/services/apexrest/Apttus_Approval/Approvals |
Versions
The Approvals API ensures backward compatibility by versioning API changes. Should changes to the API structure be required, they occur in a new version with older functionality preserved.
Content Type
Requests made to the API must be encoded as JSON and contain the header
Content-Type: application/json
Includes
You can include resource relationships on most top-level resources. Multiple includes are defined using comma-delimited values.
Caching
You can use the cacheStrategy query parameter to configure server-side caching per request.
Errors
All requests return a success or error message following standard formats.
The Approvals APIs returns an object containing a list of errors with the import, import status, and imported definition IDs.