ORBIT is LAUNCH’s companion, giving your users a screen where they can view their installed integrations as well as pause and delete them.

As a prepackaged integration management solution, ORBIT is deployed in a similar fashion to LAUNCH, being made accessible to your users via a pop-up, modal or iframe.

ORBIT’s styling and layout can also be customised from within the Cyclr Console. You can set your own custom HTML and CSS in Settings > Appearance Settings

Deploying ORBIT

You should use a non-account restricted OAuth token as the Authorization for this request.

Request to Cyclr API:

curl -X POST
-H "Authorization: Bearer ${ACCESS_TOKEN}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{}' "https://yourCyclrInstance/v1.0/accounts/{AccountId}/orbit"

ORBIT Response

JSON response from API, using the OrbitUrl will signin the user to the account and goto orbit view.

Note: URL is only valid for 5 minutes.

{
    "AccountId": "0000000-0000-0000-0000-000000000000",
    "ExpiresAtUtc": "2018-01-01T00:00:00+00:00",
    "OrbitUrl": "https://hostapp.cyclr.com/account/signinwithtoken?token=abc123&returnUrl=%2Forbit",
    "Token": "abc123"
}
Response fields Description Example
AccountId The ID of the newly created account or the existing account you provided in your request. 0000000-0000-0000-0000-000000000000
ExpiresAtUtc Token expiry timestamp. 17/01/2018 12:11:22
OrbitUrl The URL that your user should be sent to, typically opened in a popup browser window. Once generated by Cyclr, this URL will be valid for 5-minutes only and for a single request only, so you user should be passed here immediately and one time only. https://hostapp.cyclr.com/account/signinwithtoken?token=lld3UjpZKkuh0I7ObHR0EtxRsPo0No1GqNSyAi8pqXQ%3D&returnUrl=%2Flaunch
Token Orbit URL token. lld3UjpZKkuh0I7ObHR0EtxRsPo0No1GqNSyAi8pqXQ=

After deploying ORBIT you will see an API User in your Cyclr console. The API User has access to the account however they cannot signin to the Cyclr interface.

Tags: launch
Edit me