API Reference

Autenticação

Passo-a-passo para você se autenticar em nossa API

O processo de autenticação da nossa API é muito simples e seguro, e para que você comece a aproveitar os benefícios do nosso serviço, basta que você escolha um dos modelos abaixo

Autenticação via API KEY (recomendado)

Para utilizar o formato de autenticação API KEY, você deve incluir em todas as suas requisições um Header com o nome Authorization. O valor que será informado no header deve ser o token que você gerou ao se cadastrar em nosso portal.

Exemplo:

Authorization: 00000000-0000-0000-0000-000000000000

curl --request GET \
     --url https://api.nextapi.com.br/v1/cnpj/numero_cnpj \
     --header 'Authorization: 00000000-0000-0000-0000-000000000000' \
     --header 'accept: application/json'
import requests

url = "https://api.nextapi.com.br/v1/cnpj/numero_cnpj"

headers = {
    "accept": "application/json",
    "Authorization": "00000000-0000-0000-0000-000000000000"
}

response = requests.get(url, headers=headers)

print(response.text)
using RestSharp;


var options = new RestClientOptions("https://api.nextapi.com.br/v1/cnpj/numero_cnpj");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
request.AddHeader("Authorization", "00000000-0000-0000-0000-000000000000");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.nextapi.com.br/v1/cnpj/numero_cnpj")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("Authorization", "00000000-0000-0000-0000-000000000000")
  .build();

Response response = client.newCall(request).execute();

Autenticação via Query String

Para utilizar o formato de autenticação via Query String, você deve incluir em suas requisições um parâmetro chamado token. O valor que será informado no parâmetro deve ser o token que você gerou ao se cadastrar em nosso portal.

Exemplo:

http(s)://host/path?token=00000000-0000-0000-0000-000000000000

curl --request GET \
     --url https://api.nextapi.com.br/v1/cnpj/numero_cnpj?token=00000000-0000-0000-0000-000000000000 \
     --header 'accept: application/json'
import requests

url = "https://api.nextapi.com.br/v1/cnpj/numero_cnpj?token=00000000-0000-0000-0000-000000000000"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)
using RestSharp;


var options = new RestClientOptions("https://api.nextapi.com.br/v1/cnpj/numero_cnpj?token=00000000-0000-0000-0000-000000000000");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.nextapi.com.br/v1/cnpj/numero_cnpj?token=00000000-0000-0000-0000-000000000000")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

🚧

Lembre-se que o token de acesso é de uso exclusivo da sua conta e não deve ser compartilhado com terceiros.

Credenciais inválidas

Caso você não informe um token de acesso ou o token informado esteja inválido, você receberá uma resposta do tipo HTTP 401 com a seguinte mensagem:

{
  "status": "Error",
  "code": 1002,
  "message": "Auth Token not provided or invalid."
}

Consulte nossa documentação de tratamento de erros


Ao realizar o cadastro e login em nossa plataforma, você será capaz de criar e gerenciar os tokens de acesso disponíveis em sua conta.