MENU Navbar
shell

Introdução

Bem vindo á Api Navi! você pode usar nossa API para consultar dados de endereço, dados de pessoas físicas, pessoas jurídicas, enviar sms e tokens de segurnaça por sms ou email.

Abaixo estão documentados os endpoints que disponibilizamos com um exemplo de chamada logo ao lado de cada um na área escura.

Autenticação

Os headers de autorização devem seguir o padrão:


curl -X GET "https://api.navi.inf.br"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: CEP"

Não esqueça de trocar os dados de acesso pelos seus

Para ativar acesso à API, você deve possuir uma conta. Para criar uma conta acesse: Criar conta.

Todas as requisições da API esperam receber os headers de autenticação conforme exemplo:

token: api_token

cl: api_cl

service: api_service

Enpoint Base

Toda requisição deve ser feita a partir do seguinte endpoint:


curl -X GET "https://api.navi.inf.br"

https://api.navi.inf.br

Consultas

CEP


curl -X GET "https://api.navi.inf.br/cep/70049970"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: CEP"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Cep Localizado!",
  "endereco": {
    "estado": "DF",
    "cep": "70049970",
    "cidade": "Brasília",
    "logradouro": " dos Três Poderes Anexo III",
    "bairro": "Zona Cívico-Administrativa",
    "tp_logradouro": "Praça"
  }
}

Este endpoint retorna os dados de endereço de acordo com o CEP informado.

HTTP Request

GET https://api.navi.inf.br/cep/{cep}

Parâmetros

Parâmetro Descrição
{cep} cep com 8 números sem caracteres adicionais.

CPF


curl -X GET "https://api.navi.inf.br/cpf/42926920091"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: CPF1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Pessoa localizada com sucesso!",
  "pessoa": {
    "cpf": "42926920091",
    "nome": "Jose Maria",
    "genero": "M",
    "mae": "Maria Jose",
    "nascimento": "31/12/1999"
  }
}

Este endpoint retorna os dados pessoais de acordo com o CPF informado.

HTTP Request

GET https://api.navi.inf.br/cpf/{cpf}

Parâmetros

Parâmetro Descrição
{cpf} cpf com 11 números sem caracteres adicionais.

CNPJ


curl -X GET "https://api.navi.inf.br/cnpj/10735829000196"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: CNPJ1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Empresa localizada com sucesso!",
  "empresa": {
    "cnpj": "10735829000196",
    "tipo": "MATRIZ",
    "abertura": "2009-03-31",
    "nome": "JUSEMARA TATIANE BARRETE",
    "fantasia": "NAVI",
    "atividade_principal": "[{\"text\":\"Comércio varejista especializado de equipamentos e suprimentos de informática\",\"code\":\"47.51-2-01\"}]",
    "atividade_principal_code": "47.51-2-01",
    "atividade_principal_text": "Comércio varejista especializado de equipamentos e suprimentos de informática",
    "atividades_secundarias": "[{\"text\":\"Comércio varejista especializado de equipamentos de telefonia e comunicação\",\"code\":\"47.52-1-00\"}]",
    "natureza_juridica": "213-5 - Empresário (Individual)",
    "logradouro": "R DAS FLORES",
    "numero": "458",
    "complemento": "",
    "cep": "85.660-000",
    "bairro": "JARDIM DA COLINA",
    "municipio": "DOIS VIZINHOS",
    "uf": "PR",
    "email": "",
    "telefone": "(46) 3536-7604",
    "efr": "",
    "situacao": "ATIVA",
    "data_situacao": "2009-03-31",
    "motivo_situacao": "",
    "situacao_especial": "",
    "data_situacao_especial": null,
    "capital_social": "30000.00",
    "qsa": "[]",
    "extra": "{}"
  }
}

Este endpoint retorna os dados pessoais de acordo com o CPF informado.

HTTP Request

GET https://api.navi.inf.br/cnpj/{cnpj}

Parâmetros

Parâmetro Descrição
{cnpj} cnpj com 14 números sem caracteres adicionais.

CPF


curl -X GET "https://api.navi.inf.br/cpf/42926920091"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: CPF1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "NFe localizada com sucesso!",
  "nfe": {
    "id": "42926920091",
    "aedf": "8547",
    "dataEmissao": "01/01/2019",
    "dataProcessamento": "01/01/2019",
    "valorNota": "300.00",
    "nomeTomador": "Empresa",
    "identificacaoTomador": "01234567890123",
    "codVerificacao": "19B8B35056EBC65D",
    "numSerie": "23",
  }
}

Este endpoint retorna os dados da NFse consultadas.

HTTP Request

GET https://api.navi.inf.br/nfe/query

Parâmetros

Parâmetro Descrição
{numSerie} Numero de serie da NFse.
{dataInicio} Data Inicio da consulta.
{dataFim} Data fim da consulta.
{razaoTomador} Razão Social do tomador de serviço.
{identificacaoTomador} CPF ou CNPJ do tomador de serviço.
{codVerificacao} Código de verificação da NFse.

Tokens

Gerar Token por Email


curl -X GET "https://api.navi.inf.br/token/mail/gerar"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: TKMAIL"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Token enviado com sucesso para seu Email!"
}

Este endpoint envia um token gerado para o email informado.

HTTP Request

POST https://api.navi.inf.br/token/mail/gerar

Parâmetros

Parâmetro Descrição
{nome} nome do destinatário do email.
{email} email do destinatário que receberá o código
{sistema} identificador da empresa que está enviado o código, pode ser o nome ou um código, desde que seja guardado para verificação posterior do código.

Validar Token por Email


curl -X GET "https://api.navi.inf.br/token/mail/validar"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: TKVERIFY"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Código Válido"
}

    ou

{
  "status": "error",
  "message": "Código Inválido"
}

Este endpoint valida um token gerado para o email informado.

HTTP Request

POST https://api.navi.inf.br/token/mail/validar

Parâmetros

Parâmetro Descrição
{sistema} identificador da empresa que enviou o código.
{email} email do destinatário que recebeu o código
{codigo} token recebido pelo destinatário
{sistema} identificador da empresa que enviou o token, pode ser o nome ou um código, enviado anteriormente.

Gerar Token por SMS


curl -X GET "https://api.navi.inf.br/token/sms/gerar"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: TKSMS"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Enviado com sucesso!",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "id": 99999,
        "numero": "5548999999999",
        "status": "ACCEPTED"
      }
    ]
  }
}

Este endpoint envia um token gerado para o número de celular informado.

HTTP Request

POST https://api.navi.inf.br/token/sms/gerar

Parâmetros

Parâmetro Descrição
{nome} nome do destinatário que receberá o código.
{numero} número do destinatário que receberá o código com 13 dígitos, deve conter o ddi e o ddd
{sistema} identificador da empresa que está enviado o código, pode ser o nome ou um código, desde que seja guardado para verificação posterior do código.

Validar Token por SMS


curl -X GET "https://api.navi.inf.br/token/sms/validar"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: TKVERIFY"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Token Válido"
}

    ou

{
  "status": "error",
  "message": "Token Inválido"
}

Este endpoint envia um token gerado para o email informado.

HTTP Request

POST https://api.navi.inf.br/token/mail/validar

Parâmetros

Parâmetro Descrição
{numero} numero do destinatário que recebeu o código
{codigo} código recebido pelo destinatário
{sistema} identificador da empresa que enviou o código, pode ser o nome ou um código, enviado anteriormente.

Envio de SMS

Envio de SMS Long Code


curl -X GET "https://api.navi.inf.br/token/sms/long"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: SMS1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Enviado com sucesso!",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "id": 99999,
        "numero": "5548999999999",
        "status": "ACCEPTED"
      }
    ]
  }
}

Este endpoint envia uma mensagem para o número de celular informado.

HTTP Request

POST https://api.navi.inf.br/token/mail/long

Parâmetros

Parâmetro Descrição
{numero} numero do destinatário do sms
{mensagem} mensagem a ser enviada, máximo de 459 caracteres

Envio de SMS Short Code


curl -X GET "https://api.navi.inf.br/token/sms/short"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: SMS2"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Enviado com sucesso!",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "id": 99999,
        "numero": "5548999999999",
        "status": "ACCEPTED"
      }
    ]
  }
}

Este endpoint envia uma mensagem para o número de celular informado.

HTTP Request

POST https://api.navi.inf.br/token/mail/short

Parâmetros

Parâmetro Descrição
{numero} numero do destinatário do sms
{mensagem} mensagem a ser enviada, máximo de 459 caracteres

NFse

Gerar e Enviar NFse


curl -X GET "https://api.navi.inf.br/nfe/generate"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: SMS1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Nfse gerada com sucesso!",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "numero": "000001",
      }
    ]
  }
}

Este endpoint gera a NFe.

HTTP Request

POST https://api.navi.inf.br/nfe/sender

Parâmetros

Parâmetro Descrição
{razoSocialTomador} Razão social do tomador de serviço
{identificacaoTomador} CNPJ ou CPF do tomador de serviço
{codigoPostalTomador} CEP do tomador de serviço
{logadouroTomador} Logadouro do tomador de serviço
{bairroTomador} Bairro do tomador de serviço
{numeroEnderecoTomador} Numero endereço do tomador de serviço
{codigoMunicipioTomador} Código do municipio do tomador
{ufTomador} UF do tomador de serviço
{ufTomador} UF do tomador de serviço
{emailTomador} E-mail do tomador de serviço
{idCNAE} ID do CNAE de serviço
{descricaoServico} Descrição do serviçoo
{quantidade} Quantidade
{valorUnitario} Valor Unitario do serviço

Gerar e Enviar NFse


curl -X GET "https://api.navi.inf.br/nfe/sender"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: SMS1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Nfse assinada e enviada com sucesso!",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "numero": "000001",
        "numSerie": "23",
      }
    ]
  }
}

Este endpoint assina e envia a NFe para receita federal.

HTTP Request

POST https://api.navi.inf.br/nfe/sender

Parâmetros

Parâmetro Descrição
{numero} Numero da NFse

Gerar cancelamento da NFe


curl -X GET "https://api.navi.inf.br/nfe/cancel/generate"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: SMS1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Cancelamento da NFe gerado com sucesso",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "numero": "000001",
        "numSerie": "23",
      }
    ]
  }
}

Este endpoint gera o cancelamento da Nfse.

HTTP Request

POST https://api.navi.inf.br/nfe/cancel/generate

Parâmetros

Parâmetro Descrição
{motivoCancelamento} Motivo do cancelamento da NFse
{numSerie} Numero de serie da NFse
{codigoPostalTomador} CEP do tomador de serviço

Envia cancelamento da NFe


curl -X GET "https://api.navi.inf.br/nfe/cancel/sender"
-H "token: 123456"
-H "cl: dev@navi.inf.br"
-H "service: SMS1"

O comando acima retorna uma resposta JSON como a seguinte:


{
  "status": "success",
  "message": "Cancelamento da NFe gerado com sucesso",
  "resposta": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "OK",
    "status": 200,
    "detail": [
      {
        "numSerie": "23",
      }
    ]
  }
}

Este endpoint envia o cancelamento da Nfse para receita federal..

HTTP Request

POST https://api.navi.inf.br/nfe/cancel/sender

Parâmetros

Parâmetro Descrição
{numero} Numero da NFse
{numSerie} Numero de serie da NFse
{codigoPostalTomador} CEP do tomador de serviço

Erros

Nossa Api utiliza os seguintes códigos de erro:

Código de erro Significado
400 Bad Request -- Sua requisição é inválida.
401 Unauthorized -- Seus Dados de autenticação não conferem.
404 Not Found -- Não foi possível encontrar resposta para sua requisição.
405 Method Not Allowed -- você tentou acessar o endpoit com o método errado.
500 Internal Server Error -- Temos um problema com nosso servidor. Tente mais tarde.
503 Service Unavailable -- Estamos fora do ar temporariamente para manitenção. Tente mais tarde.