Overview

The purpose of this document is to provide a reference guide to API Exchange Providers and Consumers.

Throughout GSA, there are application teams hosting backend services (typically internal to GSA) that other application teams would like to use. If an application team has API Exchange proxy APIs for their backend service, that application team can now be described as an “API Provider” within the API Exchange. An API Consumer is an application team whose application utilizes an API through the API Exchange’s API gateway.
The API Exchange team supports a platform for Providers to expose and operate an API for consumption by Provider-approved consumers. Consuming APIs is the process by which the application developer accesses the various APIs that are exposed by an API provider and then uses those APIs to develop one’s own software applications and products. The following breaks down expectations and requirements for Providers and Consumers.

API Provider - Definition

Throughout GSA, there are application teams hosting backend services. If an application team does what is necessary to utilize the API Exchange to proxy their backend service, that application team can now be described as an “API Provider” within the API Exchange. API Providers host backend services that are typically internal to GSA.