This topic describes the Prodly application programming interface (API). The API helps integrate continuous delivery and release management systems to automatically perform deployments. For example, use API requests to deploy a data set or deployment plan.

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

This Prodly application programming interface (API) replaces the original, deprecated API.

</aside>

The Prodly API is a RESTful API that allows you to integrate deployments into a larger continuous integration process. Prodly API requests use the Force.com REST API to invoke actions. It also supports global Apex services for internal Salesforce automation.

These API services are available:

• Apex REST Services
• Global Apex Services

Apex REST Services

Prodly REST services provide consumers and integrated systems outside of Salesforce the ability to invoke deployments and perform other actions through REST-based API requests exposed by the Salesforce package in your Prodly control environment.

These APIs mimic and act as proxy for the the core services REST API as documented in Swagger. They just add the API key header when invoking the Prodly API.

/apexrest/PDRI/v1/instances/{instanceId}/checkin

/apexrest/PDRI/v1/instances/{instanceId}/checkout

/apexrest/PDRI/v1/instances/{instanceId}/deploy

/apexrest/PDRI/v1/instances

/apexrest/PDRI/v1/jobs

/apexrest/PDRI/v1/comparisons

Usage

The Apex REST service allows you to invoke many Prodly supported actions from applications external to Salesforce, such as a continuous delivery or release management system. For example:

• You are running CircleCI and after deploying updated code to a QA sandbox, you need to automatically deploy the updated data to the sandbox for end-to-end testing.
• You have a custom-built solution coordinating CPQ deployments that performs automated steps to promote product catalog changes between development, QA, and UAT sandboxes.

Namespace