Create and configure APIs

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, the Description and select an icon.



Your API item would be part of the path or query URL to your API.
For example, if your API item is "Daily Indicators" the route would be: "https://api.dominio.com/daily indicators/v1/metodo.json"

In addition, you should define the visibility of your API, i.e. whether it would be public or Private.

You can optionally enter Notes to display an extended description of the API in the developer portal.

Slo

SLOs (Service Level Objectives) make it possible to implement the monitoring configuration of methods and provide contextual information to developers.



Limits

Limits make it possible to define the number of queries and transfers in MB that APIs would accept per unit of time. These limits could be overwritten.

These limits make it possible to avoid misuse that degrade the service and its definition would depend on the type of APIs, the profile of developers and the problem to be resolved.

In addition, it could define timeout and time that the answer would remain cache. Cache configuration is relevant to improving response performance and its definition would depend on the frequency of updating the data.

Finally, it is possible to define in Bandwidth by application, to distribute the limits between developers' applications. This prevents a developer application from consuming all established limits, and instead of these limits being distributed among developers.



When the limits set, the API would respond with a message stating that the limits and waiting time or quarantine have been exceeded. This is known asrequest throttling limits.

Once your API was created, you would see the API tab with the settings made. You should now create your first verse.

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

    • How to create an application

      Summary The application obtains the credentials that allow you to identify when consuming APIs. Create an application To create an application you must be registered and authenticated on the portal. Once authenticated, click Create application. ...

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

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

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