Starting Guide

bizAPIs is a solution that assists companies in automating their processes, allowing access to external data such as standards and market information, etc. Moreover, it keeps companies up-to-date with changes, making operations more efficient and secure to make more informed decisions.

This page aims to provide guidance to facilitate the integration process of data coming from our Bizapis product APIs, as well as to explain some specific features of the product.

Workflow

Subscriptions (API Key)

To make requests to the bizAPIs API, it is necessary for the developer to have an API key (or as we call it, a subscription).

The subscription is not only responsible for identifying the user, but it also persists information about which services (endpoints) the developer has access to.

Registration for each of the services is individual, and at this moment, it is necessary to make a request to our commercial email in order to request that this addition be made.

Mock data

Most of the services currently have mock data to ensure that developers during the initial phases of integration with the API can perform simulations of the requests, restricting access to real data.

All requests made with the API Key provided in the documentation are solely and exclusively intended for these test data.

If there is an interest in moving to an integration using real data, please contact our commercial email.

Contacts

For more information about the product, you can visit our website, or get in touch through support .

How Make a Request

Each API contains essential documentation that provides necessary information about the endpoints, the API Key, parameters, and the available responses.

Test in Postman:

• Set up the URL:
  1. Select the POST method.
  2. The specific URL for each endpoint is provided in the documentation for each API. Copy the URL corresponding to the desired endpoint.

• Set up Authorization:
  1. Go to the "Authorization" tab in Postman.
  2. In the "Type" field, select "Bearer Token".
  3. Paste the API Key into the "Token" field.

• Set up Request Body:
  1. In Postman, select the "Body" tab
  2. Choose the "raw" option.
  3. Ensure the selected format is "JSON".
  4. Copy the requestBody according to the format specified in the API documentation.

• Send the request:
  1. After setting up the URL, authorization, and request body, click the "Send" button to send the request to the API. By following these steps, you will be ready to start interacting with the API.

HTTP Status Code

Important:

For 200 HTTP Codes, in case of error, the response body contains the field 'messageStatusCode'.

This field is composed by the service_code + bizapis_error_code

Ex: 001_011 corresponds to, error in service AT-Aggregator - Fail to login website Timeout

Service "Names" Codes

bizAPIs Standard Codes