Hosted APIs

Hosted API's

This page provides a high-level overview of the onboarding process to our hosted API's.

Our Hosted API's

Common Service	Showcase Application
Common Hosted Email Service (CHES)	CHES Showcase (CHESS)
Common Document Generation Service (CDOGS)	Document Generation Showcase (DGRSC)

Getting API access

Important Notes:

1. Visit API Services Portal and find our API in the Directory.
2. Click the Request Access button button and complete the request form with details of your application that will call that API.
3. IMPORTANT: Securely store your newly created client id and secret. (For example, in an OpenShift secret)
4. Typically within a few hours, you will be notified about your request being complete. Your credentials will then become active.

Basic process for using your client credentials

Write REST calls in your application to get a token and call the Common Services. Use the client id and secret you obtain from the API Services Portal as username/password of a Basic Auth header in a request to the corresponding token endpoint to return a bearer token. This token (a JWT) can be used (in a bearer type Authorization header) in subsequent requests to the Common Service API(s).

Check out the Postman collection(s) on the project pages from CDOGS and CHES and test data to get familiar with the API usage.