Websocket
Method define response formats for methods
Summary Output formats allow you to define one or more response formats in your API methods. Output formats can be multiple in JSON format, although it can also expose the data in CSV and XML. Configure formats When creating a method you should ...
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 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 ...
What are the types of method requests
Summary APIs methods require the definition of a type of application. We suggest that you respect REST/json standards when creating their methods, based on the following definitions. Types of request or application The methods most used in APIs ...
Method defining routes to methods: good practices
Summary Definition of routes orpathsmust be consistent with the resources or entities to which the method refers. Certain good practices for considering in defining routes. A review Before proceeding, let's look at what parts of an endpoint or url. ...
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. ...
Share private methods to registered users
Summary When you have defined your methods with Private visibility, you shouldshare with registered developers who must haveaccess to the method. Share access Methods can be protected by Keys API or the OAuth2.0 protocol. Methods protected by Keys ...
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 ...
Publish API versions
Summary An API may have one or more versions. Each verse could publish and manage each verse in isolation. This explains the flow of the APIs versions. Publish verse Once you have created an API, one version and added at least one method, you could ...
How to add data dictionaries
Summary Data dictionaries make it possible to improve the documentation of APIs and add extended capabilities on them. Configure data dictionaries To set up the data dictionary for a method, you must access the method and click on the button Data ...
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, ...
Method define custom error responses
Summary In the same way you can define formats and templates for successful application responses to a method, you can also define error templates for each format you've added and for each type of known error. Set up custom error templates Creating ...
Popular Articles
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. ...
Platform IPs
If your data sources are protected and access limited by IP lists, you can add the following addresses so that the platform can access the origins: 51.161.118.168 51.161.119.31 51.161.119.152 51.222.40.48 The IP addresses of the platform are fixed, ...
User roles
Summary Vor-Tex uses the assignment of user roles so that account administrators can control what users can and cannot do. Roles Summary: Owner: Owns the account, has the permissions of the administrator role, and can also manage the account ...
Build and publish an API from scratch
Summary In this article you would find how to use the platform to build, publish and manage your first API. In order to follow these steps you need a data source. If not, you can use this example. Example In this article we will use an example from ...
Manage your already built APIs
Summary In this article, you will find how to use the platform to manage your already built REST/JSON APIs and use the security, statistical, audit, monitoring, and other capabilities. To follow these steps, you need: An endpoint of a REST/JSON API ...