APIs catalog and documentation

APIs catalog and documentation

Summary

Once you have accessed the developer portal with your credentials, you can access the APIs catalog and its documentation.


APIs Catalogue

In the APIs Catalog you could learn about available APIs and access their documentation.

API documentation

When you access an API, you may know your documentation.

We could only access the detail of methods that are public or private, if your user has been granted access.

In the detail of a method you could know its documentation, parameters, data dictionaries, SLO and limits. In addition, you can export the specification into OpenAPI or copy fragments of code available to facilitate adoption.



    • Related Articles

    • Create and configure APIs

      Summary APIs would be exhibited on the developer portal. An API can contain multiple versions, and each of the minimum versions. To create an API you must go to APIs > New APIs. Configure APIs When creating a new API you should complete the Title, ...

    • Create APIs methods

      Summary In the article Create and manage APIs versions The first necessary steps to create APIs were shown. Methods define the action to be taken on a particular esource. As a first step you should select the option of Add Methodin the API. Add ...

    • Audit API

      Summary The Audit API allows you to consult audit records in detail of applications received and responses submitted from APIs methods. Through this API you can learn the details of each of the requests made to your APIs and the responses submitted. ...

    • Configure context variables at method parameters

      Summary Context variables allow you to associate values assigned to the account, users and applications to APIs parameters values. By setting up the API method you can relate its parameters to context variables. When a request is made to the method, ...

    • Administrative APIs: introduction

      Administrative APIs would allow you to check your account data. Administrative APIs you can consult: Statistics for the use of your APIs Audit queries made to your APIs and responses delivered Health of Methods (SLO) List of users of your account ...