Consultando o Consumo de Requisições Mensais
Como consultar a quantidade de requisições mensais realizadas na API Comercial do CNPJ.ws.
Nesse endpoint é possível consultar a quantidade de requisições que foram feitas por mês. Você deve enviar o header x_api_token com o token ou passar o token por query string na URL.
Você também pode passar o token como um parâmetro na URL, exemplo:
https://comercial.cnpj.ws/consumo?token=SEU_TOKEN
Método: GET
Endpoint: https://comercial.cnpj.ws/consumo
Atenção: As consultas nesse endpoint também contam como uma requisição à API.
Exemplo de Requisição
AuthorizationBearer <token>
Token de API (Bearer). Ex.: Authorization: Bearer <seu_token>
In: header
Query Parameters
token?string
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/consumo"{ "filtros_disponiveis": [ "string" ], "filtros_aplicados": {}, "ordenacao": [ "string" ], "data": [ { "mes": 0, "ano": 0, "quantidade": 0, "atualizado_em": "2019-08-24T14:15:22Z", "cnpjws_usuario_id": "string" } ]}{ "status": 0, "titulo": "string", "detalhes": "string", "validacao": [ "string" ], "statusCode": 0, "message": "string", "error": "string"}{ "status": 0, "titulo": "string", "detalhes": "string", "validacao": [ "string" ], "statusCode": 0, "message": "string", "error": "string"}Nós possuímos um pacote que pode te ajudar na integração com JavaScript:
yarn add consultar-cnpjconst consultarCNPJ = require("consultar-cnpj");
async function getCNPJ() {
const token = "INFORME O SEU TOKEN DE ACESSO";
const consumo = await consultarCNPJ.consumo(token);
console.log(consumo);
}Exemplo de Retorno
Abaixo um exemplo do JSON retornado:
{
"filtros_disponiveis": ["ano", "mes"],
"filtros_aplicados": {},
"ordenacao": ["ano", "mes"],
"data": [
{
"mes": 9,
"ano": 2021,
"quantidade": 1,
"atualizado_em": "2021-09-29T20:41:55.144Z",
"cnpjws_usuario_id": "d046b852-XXXX-XXXX-XXXX-8dccdf11d417"
}
]
}