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

Bizapis WorkFlow

Licenses (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 license).

The license 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.

Status Code

Status CodeMessage Code
200OK
401Unauthorized
429Too many requests
500Internal Server Error
503Service Unavailable
504Gateway Timeout

Standard Codes

Status CodeMessage Code
001Failed to login - Website Timeout
002Failed to login - Invalid Credentials
003Failed to login - Problem reaching the authentication page
004Failed to login; Failed to authenticate
005Missing authentication parameters
006The input nif is incorrect; Invalid NIF; NIF is not valid, NIPC not found
007Problem processing the request
008Problem loading the page (timeout)
009RSM not available
010Unable to access resource site
011Fail to obtain a response

Service Codes

Status CodeMessage Code
102Certificate code not found
103Document doesn't exist
104No results found for
105No vehicles registered
106No data found for the license plate
107Error reading file
108No companies found with the name
201Error solving captcha
202Failed to extract document, Failed to extract data
203Error searching for document
205Resource not found
206Page not found. Negative numbers are not allowed. Page limit is 2

Core Appication Codes

Status CodeMessage Code
502Service **** is currently unavailable

Service "Names" Codes

001AT-Aggregator
002AT-Alert
003AT-Divida
004AT-Interacoes
005AT-IRC
006AT-IVA-SA
007AT-IVA-DP
008AT-PI
009AT-IVA-Enquadramento
010NameNif