Manage your already built APIs

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:
  1. An endpoint of a REST/JSON API and its parameters, headers, and authentication or authorization scheme required by the service.

Example

This article will use a simple example of REST/JSON APIs.

It is a GET request with several parameters:


The answer to that request is:

{
"meta": {
"count":1
},
"data": [
{
"employeeId":10001,
"birthDate":"2/9/1953",
"firstName":"Georgi",
"lastName":"Facello",
"gender":"M",
"hireDate":"26/6/1986"
}
]
}


Encapsulate an already built API

Configure data source

To configure the data source, you must go to Workspace > Data sources > From web services and select the REST/JSON tab.

Enter the endpoint and all the settings required by your REST API or web service, test the connection and save the data source.

In the example used, we will enter the endpoint and then each of the parameters, defending which they would be editable and not to them. You could define validation rules and associate them with context variables on editable parameters.



In addition to exposing the result without transformation, if you want to expose other API outputs with transformations and different formats, you will have to enter the route to data and Preview the configuration to verify that the data tab is correct.

For more information on REST/JSON source configurations, access this article.

I continue to create the data view.

By setting up the API method, you can select the RAW format that allows you to deliver the same response as your service without transformation.

Select, transform your data and configure parameter validations (optional)

When you create a data view, you can select the data you want to display in the API method, add new data filters, format the data, and apply clusters and calculations.


In addition, you can add validations on editable parameters or mapping you have applied when setting up the data source.

For more information, check this section.

Configure APIs, version and method

Create APIs

To create an API, you must go to APIs > New APIs.

Enter a name and description, and select an icon and category.


Define SLOs


Define limits, maximum response time, cache, and a maximum number of rows. Then save your API.


Create version

Once you have created the API, create a version.




Add methods



You can now add a method to your API version. When adding the method, you should select the data view, configure the request and path type, and add a description, data dictionaries, and other settings.




You can define multiple output formats for your API method. In addition, you can select the RAW format that would not change the response given by the data source.




You can also define the privacy of your method.



Learn more about it in this section.

Publish APIs

Publish the version of your API so that it is available on the developer portal and can start running.



Sharing access to methods

If you defined private methods, you should share them with appropriate users so that they can access the portal documentation and start using them.





Developer portal

Try published API

Once you've published your API version, go to the portal and try the methods to validate that it works as you expect.




Learn more about it in this section.


Manage APIs

Control of changes

If you make any changes to the Workspace resources (Data Sources, Views, or APIs), you will generate draft versions which you must publish for the changes applied to impact the portal. Learn more about it in this article.

Management of environments

If you want to set up different environments for your APIs methods, you can set up the data view. How to set up multi-environment.

Version

You can add new versions to your API as you need it. You can also release the old versions if you want to lose them.

Statistics panel

In Workspace, you can access the Statistics section to learn about the consumption of APIs by response codes, users, and APIs in a period of time, by means of graphics. Read on to see this data using APIs.




Administrative APIs

Administrative APIs allow you to know your APIs' statistics, audit documents, and service levels. Learn more about it in this section.

Statistics

If you want to integrate statistical data into your visualization systems or programs you can use the Statistics API, available on the Administrative APIs portal.

Audit

You can know the details of the requests received and responses submitted through the Audit API, available on the Administrative APIs portal.

Monitoring

If your account is enabled to monitor methods, you can know its availability levels using the monitor API on the Administrative APIs portal.





    • Related Articles

    • Create a Vor-Tex account

      Signup in Vor-Tex at https://workspace.vor-tex.io/signup/ You should first enter your email. You would then receive this message and an email at the address entered with a link to continue the registration process. You should complete the form to ...

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