Common API service

API Specifications

Staging Environment: NA

Production Environment: NA

Overview

The Common API service enables agencies to call product APIs registered in Console.

As a product, you can opt in to this service to make your APIs available to agency users via Console, allowing them to automate workflows that depend on your product.

Agency features

When using the Common API service, Console handles common functionality such as authentication and API key management on behalf of agencies.

This means your product does not need to implement these functions for agency integrations.

💡 For details on how agencies use this service, see the agency guide.

Onboard to the Common API service

To onboard your product APIs to the Common API service, complete the following steps:

1. Prepare your OpenAPI specification document
2. Establish server connectivity with Console
3. Validate requests from agencies

⚠️ All three steps are required before agency users can start calling your APIs through Console.

💡 There are no public staging or production API specifications for this service.