The Deploy RESTful API can be used to enable and monitor the deployment of packages containing document flows in projects and environments.

Enabling document flow

A first step would be to enable document flow for your environments in your project. By enabling document flow for an environment, document flow projects will be detected and will be deployed. You need to enable each environment individually. After this, deployment of document flow projects will be possible.

Note that enabling an environment will also trigger a deploy of all packages already present.

The base URL for the Deploy RESTful API is https://deploy.compose.platform.unifiedpost.com/api

Deploys caused by modifications

For all environments, except for the first one, deployment happens automatically when a file in the document flow project changes. The system will monitor the base path of the environment. If a change happens, the system will figure out whether it belongs to a document flow project and will deploy or redeploy the project accordingly. This means that packages can simply be promoted using Resource Promotion and the new version will come online.

Deploys triggered by an API call

The first environment of a projects isn't automatically deployed in response to a modification because this environment is likely mapped to your local designer workspace and will receive many updates while you're developing your package. For the first environment in a project, a deploy can be triggered manually using the POST operation on /v1/documentflow/package. This call allows you to schedule a deploy of a specifc document flow project.

Deploys scheduled by the System

Finally, deploys can be triggered by the system to install system updates or apply bug fixes. This type of trigger can occur at any time on all environments.

All requests to the Deploy API must be authenticated. See OAuth 2.0 for information on how to obtain security tokens and Performing authenticated requests on how to use them.

The Deploy API uses https://login.inventivedesigners.com as its authentication and authorization server.

Users that make calls to the Deploy API should have permission output-center. In addition to this they should also have access to the different resources.

When you are making requests at a higher rate than your usage plan allows an HTTP status code of 429 will be returned. In this case, you can safely retry this call, but you should lower the rate at which you are sending requests.

While our service is scaling, it is possible an HTTP status code of 500 or 504 might be returned rather than a 429. After a couple of seconds our service will have scaled up, and you can restart sending requests, which will be successfully handled again

When the package is deployed, invoke it using the Xribe Output API by submitting a message with an input of type documentflow.

Manage environments and deploy packages.