Skip to main content
Cada chamada leva a chave de API da organização no cabeçalho Authorization:

​
A chave

  • A chave começa com qx_.
  • A chave pertence a uma organização. A chamada alcança só os dados dessa organização.
  • O admin do QX cria a chave e entrega o texto da chave por um link de uso único. O texto aparece uma vez só.
  • Guarde a chave no gerenciador de segredos do seu servidor.
  • Nunca envie a chave por e-mail, e nunca grave a chave em log.
  • Se a chave vazar, peça ao QX a revogação. A próxima chamada com a chave revogada recebe 401.

​
As recusas

A API confere a chave e a organização antes de cada chamada.

​
Os limites

Uma escrita paga é uma chamada que dispara um serviço pago, como a consulta de um CNPJ ou a leitura de um documento. As escritas pagas são estas:
  • POST /contacts;
  • POST /collections;
  • POST /documents;
  • PATCH /documents/{id} com file.
  • O dia do limite diário segue o fuso da organização. O limite volta à meia-noite.
  • Cada resposta 429 traz o cabeçalho Retry-After, com os segundos de espera.
  • O QX ajusta o limite diário de uma chave a pedido da organização.