Pular para o conteúdo
Docs

Referência: Conta e tabelas de referência

Atualizado em

Nesta página

Rotas de apoio para a sua integração: quem é a chave, quanto da cota já foi usado e as tabelas oficiais de serviços e municípios. Todas aceitam qualquer chave válida, sem escopo específico.

Método Rota Escopo
GET /integracao/me qualquer chave válida
GET /integracao/referencia/servicos?q= qualquer chave válida
GET /integracao/referencia/municipios?q= qualquer chave válida

Conta: GET /me#

Devolve a empresa da chave, o ambiente, o plano, os limites e o uso do mês. Use no início da integração para confirmar que está na empresa e no ambiente certos.

cURL
curl https://emitra.com.br/api/v1/integracao/me \
  -H "Authorization: Bearer $EMITRA_API_KEY"
Resposta 200
{
  "status": "success",
  "message": "Operação realizada com sucesso",
  "data": {
    "empresa": {
      "id": "0b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
      "razao_social": "Estúdio Exemplo Ltda",
      "cnpj": "11222333000181",
      "municipio_ibge": "3550308",
      "ambiente_fiscal": "producao_restrita"
    },
    "chave": {
      "nome": "ERP Teste",
      "prefixo": "xxxxxxxx",
      "ambiente": "test",
      "escopos": ["customers:write", "nfse:emit", "nfse:read"],
      "expira_em": "2027-11-11T00:00:00-03:00"
    },
    "plano": { "codigo": "profissional", "nome": "Profissional", "status_assinatura": "active" },
    "limites": { "notas_mes": 150, "chamadas_por_minuto": 120 },
    "uso_mes": { "periodo": "2026-11", "notas_autorizadas": 37, "chamadas_api": 1284 }
  }
}
Campo Descrição
empresa.ambiente_fiscal Para onde vão as notas de uma chave live: producao_restrita ou producao
chave.ambiente test (sandbox) ou live
plano.status_assinatura trialing, active, past_due, blocked ou canceled
limites.notas_mes Cota do plano. null = sem limite contratado
uso_mes.notas_autorizadas Notas que já consumiram cota no mês

Códigos de serviço#

GET /integracao/referencia/servicos?q= busca na Lista de Serviços Nacional (cTribNac) por código ou descrição.

cURL
curl "https://emitra.com.br/api/v1/integracao/referencia/servicos?q=consultoria%20tecnologia" \
  -H "Authorization: Bearer $EMITRA_API_KEY"
Resposta 200 (trecho)
{
  "status": "success",
  "message": "Operação realizada com sucesso",
  "data": {
    "items": [
      { "codigo": "010601", "descricao": "Assessoria e consultoria em informática." }
    ]
  }
}

A busca é por texto, sem IA. Ela ajuda a encontrar candidatos; a escolha do código é sua ou do seu contador.

Municípios#

GET /integracao/referencia/municipios?q= busca municípios por nome ou código IBGE de 7 dígitos.

cURL
curl "https://emitra.com.br/api/v1/integracao/referencia/municipios?q=sao%20paulo" \
  -H "Authorization: Bearer $EMITRA_API_KEY"
Resposta 200 (trecho)
{
  "status": "success",
  "message": "Operação realizada com sucesso",
  "data": {
    "items": [ { "codigo_ibge": "3550308", "nome": "São Paulo", "uf": "SP" } ]
  }
}

Próximos passos#

Esta página foi útil?