Scalar API Reference

Scalar renders each of the OpenAPI specifications with an interactive API reference, and enables you to invoke the services directly from the browser.

This is helpful for testing out endpoints, or quickly seeing what’s available.

Accessing Scalar

Scalar is available from the main nav bar in the SDL UI under the API Docs dropdown.

Each service has its own OpenAPI specification displayed through Scalar.

Authorization

Before you can invoke any of the endpoints, you must configure your credentials. Click the "Authentication" section in the left sidebar to configure one of the supported methods:

  • OAuth2 - OAuth2 single-sign on.

  • Basic - Basic authorization with username/password credentials.

  • Bearer - Bearer authorization with a JSON Web Token (JWT).

Only one method is required.

If you supply Basic credentials, SDL will use those credentials to retrieve a JWT from Keycloak and use that JWT for all downstream authorizations.

If you supply a JWT, it will be passed down as is.

Trying an Endpoint

Once you have configured authentication, you can invoke endpoints by:

  1. Select an endpoint from the left sidebar to view its details.

  2. Review the Parameters section for available parameters and request body (if applicable).

  3. Review the Responses section for documented response types.

  4. Click "Send" to invoke the endpoint.

  5. The response section will display the status code, headers, and body that came back.