This section describes the APIs that partners can use to create and manage Embedded Journeys, related users, and the connections required for Embedded Journey consumption.
Partner APIs are generally consumed by the partner’s server-side implementation to automate Embedded Journey setup in a controlled and scalable manner.
Using these APIs, a partner can:
- Authorise requests using the partner token
- Create and manage embedded users
- Generate short-lived one-time tokens for users
- Establish connections on behalf of users
- Retrieve and search Embedded Journeys
- Create Embedded Journey instances, where required
- Start or stop Embedded Journey instances
What can partners do?
Partners can use these APIs to manage the Embedded Journey lifecycle.
| Area | What the partner can do |
|---|---|
| Users | Create users, list users, and generate short-lived one-time tokens for secure end-user access. |
| Connection | Fetch connection configuration, establish connections on behalf of end users, disconnect connections, and delete connections. |
| Embedded Journey | Retrieve and search for Embedded Journeys. |
| Embedded Journey Instance | Create Embedded Journey instances, start or stop Embedded Journey instances for end users. These APIs are generally consumed by the Embedded Journeys UI, but partners can use them when building a custom interface. |
Typical partner flow
- Create an Embedded Journey.
- Optionally add config data if inputs need to be captured from the user during setup and used to control the user interface.
- Publish the Embedded Journey.
- When the user requests or consents to use the Embedded Journey, such as by clicking a button or through another implementation flow, create the user if the user does not already exist.
- Generate a short-lived one-time token for the user.
- Use the one-time token to create an instance of the Embedded Journey.
- Pass the Embedded Journey instance ID and the one-time token to the Embedded Journeys UI.
- If building a custom interface, use the Embedded Journey Instance APIs to configure and manage the user-specific instance.
Partner authentication
The Partner APIs use the partner token in the request header,
Authorization: api-key <partnerToken>Base path
The basePath represents the environment-specific base URL used to make API requests.
{basePath}During integration setup, Quickwork will share the base path and partner token for the relevant environment. These values must be configured before API requests can be tested.