SprintPass Pro Orchestration API provides the ability for integrators to submit container appointment and/or payment orchestration requests and receive status tracing on the submitted containers.
A single request may contain multiple orchestrations to be processed by the SprintPass Pro system, following this flow:
Customer sends Orchestration Request (possibly containing multiple orchestrations).
Orchestration(s) begins for each container once the container is reported by the terminal. Customer receives container status updates throughout the lifecycle of the orchestration published to Azure Service Bus. The status can also be queried at any time via the REST API.
If customer includes payment options, the orchestration keeps fees paid up until the guaranteed through date. A status update is sent to Azure Service Bus on each payment event.
If the customer includes appointment preferences, the orchestration requests an appointment as soon as the container is available for it. A status update is sent to Azure Service Bus on each appointment event.
The orchestration stays active and can be updated with empty drop appointment preferences.
If the customer includes dual move information, the appointment is set up to support both the pick and drop moves.
The orchestration ends when the container is gated in.
When creating multiple orchestrations in one API call, we recommend at most 100 orchestrations per API request in order to avoid a possible timeout. Rate limits may apply.
REST API integration:
- SprintPassPro provides: API endpoints and subscription keys
Microsoft Azure Subscription Endpoints:
- SprintPass Pro provides: Azure subscription endpoints and Shared Access Signature (SAS)
- JSON