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

    • 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. ...

    • 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 ...

    • Try a method

      Summary The developer portal allows you to test reading methods (GETs) on the same portal. Test method Enter an API in the APIs Catalog on the portal's homepage. Then select a method and click on the buttonTest method. Select the implementation which ...

    • Introduction to WorkSpace

      Summary Workspace is where owners, administrators, publishers, and editors access to manage APIs. In this section, you can find the workspace documentation. We suggest reading What are data resources. If you were unable to access it, please read ...

    • Domains customization

      Summary By default, the platform offers domains under *.vor-tex.io, although it can use its own domains. Configure domains To configure your Gateway API Developer Portal domains and environments, theadministrator of your domain must create CNAME ...