An overview of our API documentation
The Ui.Marketing API extends the functionality of Ui.marketing to allow partners to view proposals and orders within another platform. Using the API, you can manage and measure your digital proposals to automate workflows.
If you are new to Ui.Marketing and interested in learning more about our API suites and use cases, along with needing API access or API users looking for support, please contact our Support Team.
Common Use Cases
NOTE: If you cannot access any of the following pages or need access to a specific feature, please contact our Support team for the appropriate permissions.
|
USE CASE |
DESCRIPTION |
|---|---|
|
Generate reports for Proposals |
Schedule reporting for proposals that were created inside the Ui.marketing that allow users to view Ui.Marketing digital line items alongside other digital offerings |
|
Generate reports for Orders |
Schedule reporting for orders that were created inside the Ui.marketing that allow users to view sold digital line items alongside of other digital offerings |
API Access
IMPORTANT: You must log in to access the following environments. If you don't have your API credentials, please contact our Support Team.
Your API credentials provide access to both a staging and a production environment. Use these environments to manage testing and production-release processes. Specify which environment to make calls to by using its corresponding root endpoint, as shown below.
|
ENVIRONMENT |
ROOT URL |
|---|---|
|
Staging |
|
|
Production |
Staging Testing Environment
Use the staging environment to test API integrations, since staging code will be typically aligned with the code base of our production environment.
Here's what you need to know about the staging testing environment:
-
Proposal and Order IDs will not be the same as production
-
Your API credentials will be the same in staging and in production
Protocol
All HTTP requests are authenticated against our internal AIM provider by validating every HTTP request against your account’s credentials. The credentials must be included in the ‘Authorization’ header of your request as defined by the ‘basic’ authorization specification RFC 7617.
API Changes and Updates
Occasionally, new features or capabilities are introduced to the platform API that is backward-incompatible.
To remain informed of the platform updates, make sure to check the following pages on a regular basis.
|
PAGE |
CONTENT DESCRIPTION |
|---|---|
|
Release Notes |
A list all new features and updates made to the platform API suites |
IMPORTANT: Ensure that your JSON serialization library will allow unknown properties to appear in the JSON response without causing an error, which is standard behavior in most JSON serialization libraries.