Using the OpenAPI console

The OpenAPI console is a web application where you sign in with your API credentials and see the APIs those credentials can invoke. It shows live documentation - endpoints, request and response schemas, examples - together with a try-it client that invokes the real APIs. The documentation is generated from the services actually deployed on the platform, so what you read always matches what runs.

You need two things to use it, both issued by the administrators of your environment:

• The console's address
• Credentials

Sign in

Open the console's address in a browser and you land on the sign-in page. Which values go into the form depends on the kind of credentials you received:

If your organization uses Microsoft Entra ID and your admins enabled it for the console, a "Sign in with Microsoft" button appears above the form and you can use your Microsoft account instead.

With wrong credentials, the sign-in page shows an error and nothing else - no API details are visible before a successful sign-in.

What you see and why

The document you receive after signing in contains exactly the endpoints your credentials can invoke, nothing else. This is not a display preference - the filtering happens on the platform's servers before anything reaches your browser, and other callers' endpoints are never sent to you.

If an endpoint you expect is missing from your view, your credentials do not grant it - ask your admins to check what your account has been assigned.

Try endpoints out

Every endpoint in the console has a try-it client. It sends a real request to the actual API, using the credentials you signed in with - the same permissions apply as when you call the endpoint directly from your own code. Fill in the request body based on the schema shown and the response comes back with its status code, headers and body.

Connect your own tools

The document behind the console is a standard OpenAPI 3.1 specification, available in two formats under the console's address:

/openapi/console/openapi.json
/openapi/console/openapi.yaml

Paste either URL into Postman, an API gateway, a code generator or any other tool that understands OpenAPI, and authenticate with the same credentials you sign in with. The document is always current - it is regenerated whenever the services behind it change, so there is no stale export to refresh.

Call the APIs from your code

The URL, HTTP method and schemas shown for each endpoint are the live contract of that API. A minimal call with curl, using Basic Auth credentials:

curl -u myuser:mypassword https://api.example.com/api/customer/get -d '{"customer_id":"123"}'

For anything larger, generate a client from the spec URL above - the generated code stays correct for as long as the contract shown in the console does not change, and the platform's administrators are notified of contract changes whenever the APIs are redeployed.

Sign out

Use the logout link in the console. Your session ends and the sign-in page appears again - the spec URLs also stop responding for your session until you sign in once more.

For administrators

If you run the platform yourself, the OpenAPI administration page covers the console's architecture, which channels are documented, auto-created channels, branding and ports.

See also

Learn more