API Documentation

Access API documentation.

Table of Contents

1. Does the platform provide API documentation?
2. How do I access the API documentation?

Does the platform provide API documentation?

Each API includes a set of reference documentation which is available via the My APIs > API Name > Documents tab. The specifics in terms of what documentation is offered vary from API to API.

In some cases, certain APIs, or portions of them, have restricted visibility. In those cases, you would need to be invited to have visibility into those properties and their associated documentation. However, in many cases, the API documentation is publicly shared. You can locate it by using the Search feature in the platform.

A typical API documentation set might include the following sections:

• Overview—A summary of the API functionality, links to reference documentation for the operations, and a Getting Started section that illustrates key information and steps for using the API.
• Developer Guide—Reference documentation for each API operation (method). A typical organization might include use cases, URI (endpoint), sample request, request parameters, sample response, response parameters, and error handling information.
• Users Guide—Instructions for how to connect to the API, and ideally a walkthrough of API use cases.

Back to top

How do I access the API documentation?

To access the API documentation:

1. Select My APIs > API Name > Documents. The Documents page for the selected API displays.
2. Review the documentation, clicking through to additional pages as needed.

Back to top