Using the Product Catalog Developer Portal

The API developer portal serves as a central hub for developers who want to learn about, access, and use the Product Catalog APIs. The content on the developer portal helps developers build their organization’s systems and ensures a smooth transition to using the Product Catalog APIs.

Developer Portal Capabilities

The developer portal offers the following capabilities:

  • A glossary of terms, along with definitions and examples of key Product Catalog concepts, such as products, bundles, and rule sets.
  • List of API prerequisites and authentication requirements, success and error codes, and limitations. Code samples are included.
  • Details of each API, including their respective endpoints, methods, paths, and fields.
  • An API “mock” service that allows you to submit realistic, pre-defined API requests and observe the expected responses.

API Mock Service

The mock service environment enables you to try out the Product Catalog Intake and Subscription APIs using the OpenAPI 3.0 format. The mock service offers an assortment of scenarios that represent actual design contracts and is not connected to a live backend system. This controlled environment enables you to experiment with a range of simulated inputs and outputs so that you can understand the behavior of the APIs in various scenarios and still avoid the risks associated with using production data.

ATPCO invites you to share your experiences using the APIs in the mock service. For example, if you want to investigate an use case that is not provided or if you foresee challenges with integrating to the APIs, we welcome the opportunity to meet and discuss your situation to determine how we can assist you in meeting your goals for using the APIs.

Developer Portal Site Navigation

Here are some suggestions for navigating the developer portal site.

Mock Service Navigation Bar

The following navigation bar is positioned across the top of the mock service pages of the site.

mock-service-nav-bar.png

Here are instructions for using the navigation bar elements.

  1. On the navigation bar, click Routing: Proxy. When accessing the mock service, be sure to use the Routing requests via secure proxy setting.
    try-it-out.png

  2. On the navigation bar, use the radio button to select either Elements or SwaggerUI.

    • The Elements setting provides a granular view of each request and response field in the selected message type.
    • The SwaggerUI setting provides a comprehensive view of all the message types and enables you to send requests and view expected responses in the mock environment.

  3. Please ignore the Open in Explore option.

  4. Please ignore the Generate Code option.