APIs

An API represents an API product that the Portal admin set up to bundle the APIs that you are able to access. The following restrictions apply:

  • APIs might be marked as private and can be protected by a PortalGroup. Only authorized users can see the API in the frontend app.
  • Portal users can view the specification and documentation of public APIs in the API catalog. However, access to an API is denied until the following conditions are met:
    • The user’s team is subscribed to an API with an API subscription.
    • The API subscription is approved by a Portal admin.
    • The user self-serviced the appropriate credentials to access the API.
  • Portal users cannot change or remove APIs from the API catalog.

View API specs and docs

  1. Log in to the frontend app as a Portal user.
  2. In the frontend app, go to APIs.
  3. Find the API products that the Portal admin created and select the one you want to see the details for.
  4. Review the API’s specification (Spec) or documentation (Docs). You can also add the API product to an app by using the SUBSCRIBE button.

Test API access

  1. Log in to the frontend app as a Portal user.
  2. Select APIs, and find and select the API product that you are subscribed to. The API specification opens automatically using a Redoc View.
  3. Click Swagger View to change to the Swagger view.
  4. Click Authorize. Depending on how the Portal admin protected your API, you either see a window to enter an API key or an ID token. The following image shows an example for an ID token when OAuth auth is enabled for the API.
  5. Enter the API key or ID token that you created and click Authorize. To create credentials to access your APIs, see Create API credentials.
  6. Select an API that you want to try, such as GET tracks/tracks.
  7. Click Try it out, and then Execute. Verify that you get back a 200 HTTP response code. Note that the Portal admin might set up default rate limits for that API.