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.

Endpoint Base

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


curl -X GET "NAVIAPI/api/v1"

NAVIAPI/api/v1

Autenticação

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


curl -X GET "NAVIAPI/api/v1"
-H "Autentication: Bearer 123456"
-B "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:

Autentication: Bearer api_token

Tradução

Para obter o resultado em diferentes idiomas, basta incluir um parâmetro adicional na chamada.

Parâmetro Descrição
{lang} string. Deve conter 'pt', 'en', 'de', ou 'es' opcional

Consultas

CEP


curl -X GET "NAVIAPI/api/v1/cep/70049970"
-H "Autorization: Bearer 123456"
-B "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 NAVIAPI/api/v1/cep/{cep}?service=CEP1

Parâmetros

Parâmetro Descrição
{cep} cep com 8 números sem caracteres adicionais. Obrigatório
service pode ser CEP1(default), CEP2 ou CEP3 opcional

CPF


curl -X GET "NAVIAPI/api/v1/cpf/42926920091?service=CPF1"
-H "Autorization: Bearer 123456"
-B "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 NAVIAPI/api/v1/cpf/{cpf}

Parâmetros

Parâmetro Descrição
{cpf} cpf com 11 números sem caracteres adicionais. Obrigatório
service pode ser CPF1(default), CPF2 ou CPF3 opcional

CNPJ


curl -X GET "NAVIAPI/api/v1/cnpj/10735829000196?service=CNPJ1"
-H "Autorization: Bearer 123456"
-B "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 NAVIAPI/api/v1/cnpj/{cnpj}?service=CNPJ1

Parâmetros

Parâmetro Descrição
{cnpj} cnpj com 14 números sem caracteres adicionais. Obrigatório
service pode ser CNPJ1(default), CNPJ2 ou CNPJ3 opcional

Tokens

Gerar Token por Email


curl -X GET "NAVIAPI/api/v1/token/mail/create"
-H "Autorization: Bearer  SEUTOKEN"

O comando acima retorna uma resposta JSON como a seguinte:


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

Este endpoint gera um toke aleatório e envia para o email informado.

HTTP Request

POST NAVIAPI/api/v1/token/mail/create

Parâmetros

Parâmetro Descrição
{name} nome do destinatário do email.
{email} email do destinatário que receberá o código
{system} 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.

Gerar Token por SMS


curl -X GET "NAVIAPI/api/v1/token/sms/create"
-H "Autorization: Bearer  SEUTOKEN"

O comando acima retorna uma resposta JSON como a seguinte:


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

Este endpoint gera um toke aleatório e envia para o telefone informado.

HTTP Request

POST NAVIAPI/api/v1/token/sms/create

Parâmetros

Parâmetro Descrição
{name} nome do destinatário do email.
{phone} Telefone de destino [DDI DDD NUMERO] EX: 5548999999999
{system} 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


curl -X GET "NAVIAPI/api/v1/token/validate"
-H "Autorization: Bearer SEUTOKEN"

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 NAVIAPI/api/v1/token/validate

Parâmetros

Parâmetro Descrição
{system} identificador da empresa que enviou o código.
{email} ou {phone} email ou telefone do destinatário que recebeu o código
{code} token recebido pelo destinatário

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.
shell