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

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

    • Configure APIs and Methods Privacy

      Summary You can define the privacy of your APIs and methods to grant access only to users you want, or revoke accesses when you require it. Privacy rules You can set up the visibility of APIs and methods, i.e. whether they would be public or private. ...

    • Create and manage APIs versions

      Summary An API may have one or more versions. Each version contains API methods, and may have multiple versions published at the same time. Consider adding new versions of APIs when changes you make impact on queries that receive your methods and/or ...

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

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