Getting Started

Here's an overview of how to get started with Tosca's APIs.

API Credentials

Login ID and Password from the Tosca Hub will be used.  Send an email to Tosca Customer Solutions if you need credentials.

Create your Developer Account

To start working with Tosca APIs, you'll need to create a Tosca developer account. Already have a Tosca account? You'll still need to create a developer account, but you can use the same email address. From the home page, click Sign up, enter your info and you're all set!

Account Activation

After signing up, your account will be reviewed and authorized.  Once authorized, you will receive an email with a verification link. Click the verification link to activate your account.

Sign In

Verify your credentials and sign in to the developer portal.

Subscribe to Tocas's APIs

Once you have a Tosca developer account, you can  subscribe to our APIs. Here's what you need to do:

  1. Sign in and access our Product options

  2. Choose the product which best fits your needs. 

  3. Name the Subscription and click Subscribe.

Getting your Access Key

Once subscribed to a product, the access key is available in the Subscriptions section under your Profile.  The Primary or Secondary key can be used to access an API.

Postman Collection

The Postman collection contains the examples. Follow these steps with the Postman collection:

  1. In the Postman collection, the environment settings has a few variables that are required:

    • enterpriseApiKey : Retrieve from your developer portal account. This is the subscription key.

    • user email / user password : Credentials used to authenticate to the API tier. These values can also be used to log into the Hub UI.

  2. Use the Postman collection provide the authorization token needed for the Dev Portal. Follow these steps:

    • Login API : Run the login API first

    • Authorize API : Run the authorize API second. The authorize API will return an "accessToken". This token can be used to run the APIs in the Dev Portal - see next section.

  3. The Postman collection contains more examples that can be run after the previous step using the "accessToken".

Using the APIs in the Dev Portal
An access token is required to use the APIs in the Dev Portal. Using the Access Token from the previous step in the Postman Collection, follow these steps:

  1. Select the API and click "Try it"

  2. Your subscription key will automatically be selected as a header

  3. Click "+ Add header" to add a new header to send the access token in the format.  The <access token> is obtained from the previous step in the Postman Collection.

    • Name: Authorization

    • Value: Bearer <access token>

  4. Send the request

Tosca Hub Console

The following environments are available to access the Tosca Hub:

Use your Login ID and Password provided by the Tosca Customer Solutions to access the site.