Deploy a marketplace
There are two ways to deploy Cyclr’s Marketplaces. Which you choose depends on whether you intend to give your customers direct access to Cyclr or not:
If you don’t plan to give your customers direct access to Cyclr - to see Cycles, build their own integrations, etc - then Account Deployment is the way to go.
If you do, then it may be useful for your customers to see which of their colleagues has started or stopped a Cycle, for instance. In this case you can choose User Deployment.
Account Marketplace Deployment
A single and generic “API User” is used when installing Templates creating Cycles.
You create a button within your own web application’s interface that allows your users to view a Marketplace and install Integration Packages.
When that button is clicked you would:
Make the following request from your application server to the Cyclr API’s
/v1.0/accounts/{id}/marketplace
endpoint to obtain a Marketplace URL.Direct the user to the URL in their web browser, perhaps within an iframe.
For more information about this endpoint, see the Interactive API reference page.
Note: If you deploy a Marketplace, you can see an API User in your Cyclr Partner Console under Accounts > Account Management. The API User has access to the Account, but can’t sign in to the Cyclr interface.
“Account” Marketplace Request
curl -X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"MarketplaceId": {MarketplaceId},
"AccountName": "{CyclrAccountName}",
"ConnectorAuthentications": [
{
"Name": "{ExampleConnector}",
"Version": "{VersionNumber}",
"AuthenticationId": "{AuthenticationId}",
"AuthValue": "{AuthenticationValue}",
"Properties": [
{
"Name": "{Url}",
"Value": "{http://customDomain.appName.com}"
}
]
}
]
}
' "https://{CyclrAPIDomain}/v1.0/accounts/{CYCLR_ACCOUNT_API_ID}/marketplace
Note: Pass all
ConnectorAuthentications
property values as strings, even if they’re numeric.
Request Parameters
Request parameter | Type | Description | |
---|---|---|---|
| string | Enter your Access Token to authenticate the Cyclr API. | |
| string | Specify your API domain according to the location of your Cyclr console. If your Cyclr instance is self-hosted, this value is your own domain. | |
| string | API ID of the account to use. If an account with this API ID doesn’t exist, Cyclr creates a new account using this value. | |
| integer | Identify the marketplace to show. | |
| Boolean, optional | Set to | |
| string, optional | Name the account if you create a new account. | |
| string, optional | Provide a description of the account. | |
| array, optional | Use connector authentication to avoid the need for your users to authenticate against your platform. | |
| string | Name the instance of your connector in the account. | |
| string | Specify the version of the partner connector that you install. For example, | |
| string | Identify the connector authentication method you want to use. | |
| string | If your platform needs a username and password, provide a base64 encoded version of "username:password". You can also use an OAuth token, or provided API keys as plain text. | |
| Array, optional | Provide properties that some partner connectors need to successfully install. | |
| string, optional | A custom value be included in the Marketplace webhook callback. |
“Account” Marketplace Response
{
"MarketplaceUrl": "{MarketplaceUrl}",
"AccountId": "{AccountId}",
"Token": "{UrlToken}",
"ExpiresAtUtc": "{DateTimeValue}"
}
Response Parameters
Response Field | Description |
---|---|
| Provides the ID of either the new account, or the account that you specified in the request. |
| Displays when the Token and MarketplaceUrl expires. |
| Provides the URL you can send your user to. This URL expires five minutes Cyclr generates it or when the user accesses it. |
| Provides the Marketplace URL token. |
User Marketplace Deployment
To deploy a “User Marketplace”, you make a similar request to the Account Deployment, but to the Cyclr API’s POST /v1.0/users/marketplace
endpoint and also provide the Username
of the “User” accessing the Marketplace.
Console Users and Users are not the same:
Console Users - exist within the Cyclr Partner Console and should only be created for your colleagues.
Users - exist within Accounts > User Management. They only have access to one or more Accounts and cannot access the Partner Console.
For more information about the endpoint, see the Interactive API Reference page.
There are 3 additional properties to use in this Request:
Request Parameter | Type | Description |
---|---|---|
| string | The Cyclr Account API ID of the Account to use. If it doesn’t already exist, a new Account will be created. |
| string | Identifies the user. If the user doesn’t already exist, a new User will be created with these details. |
| string | Password of the user. |
“User” Marketplace Request
curl -X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"MarketplaceId": {MarketplaceId},
"AccountId": "{CYCLR_ACCOUNT_API_ID}",
"Username": "ExampleUser",
"Password": "P4$$w0rd",
"ConnectorAuthentications": [
{
"Name": "{ExampleConnector}",
"Version": "{VersionNumber}",
"AuthenticationId": "{AuthenticationId}",
"AuthValue": "{AuthenticationValue}",
"Properties": [
{
"Name": "{Url}",
"Value": "{http://customDomain.appName.com}"
}
]
}
]
}
' "https://{CyclrAPIDomain}/v1.0/users/marketplace