What is an API?

An API is an Application Programming Interface. It is a set of routines, protocols, and tools for building software and applications. An API provides all the building blocks, making it easier to develop a program by just putting it all together.

For each of the APIs links are provided to the associated syntax. Apigee is used to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. Other documentation and a client interface that demonstrates the associated API is also provided.

What is oAuth 2.0?

All APIs are protected by OAuth 2.0 -  Client Credentials grant type. With the Client Credentials grant type, the client sends its own credentials (the Client ID and Client Secret) to an endpoint URL that is set up to generate an access token. If the credentials are valid, an access token is returned to the client app. The client is then required to send the access token on all the API calls. API calls with invalid access token are rejected with ‘HTTP 401 Unauthorized error’. 

How does one obtain an oAuth access token?

Client applications need Client ID and Client Secret to obtain the oAuth 2.0 access token. To obtain the access token, call the URL  by sending the Client ID & Secret in the HTTP, basic authentication header. The access token is valid only for 60 minutes, so call the refresh token URL  to refresh the token. Separate access tokens are provided for test and production environment.  Client ID and Secret are obtained by creating apps for the API Product in the My APPs page. The test products have the suffix 'TEST' and the Production products have the suffix  ‘PROD’.


For the production environment , the Client ID and Secret are provided only to the Company Admin.  

In Manage Companies, who can invite developers?

Administrators can invite developers by clicking Invite.  

Why does an Admin need to invite developers?

Since the Admin and Developers share the application oAuth credentials within a company, the Admin can invite other developers within the same company.

As an Admin, how do I invite developers?

In Manage Company, click on the company name and enter the email ID then click Invite.