TOKEN DE ACESSO

Introdução Última atualização: 02/06/2021

A nossa API foi pensada para que você consiga fazer uma integração simples e rápida, a fim de agilizar seus processos e melhorar a experiência dos seus usuários.

Esta documentação lhe fornecerá todas as instruções necessárias para uma rápida integração aos serviços que oferecemos. Qualquer linguagem de programação pode ser utilizada para consumir as respostas de nossa API.

Guia Rápido

Todas as solicitações na API devem ser realizadas através da URL https://api.faladevs.com/. Todas as respostas da API estão no formato JSON e pode ser utilizado por qualquer linguagem de programação.

Autenticação

Para começar a utilizar a nossa API, é necessário que você gere um Token de Autenticação. Esse Token é importante pois deve ser enviado no Header de todas as requisições. Não possui um Token? Preencha o formulário abaixo para receber as suas credenciais grátis via email.

Exemplo de Requisição com Token

                
  curl --location --request GET 'https://api.faladevs.com/v1/cpf' \
  --header 'Authorization: Bearer YOUR_TOKEN_HERE'

Acesso não autorizado


{
  "message": "Acesso não autorizado. Para usufruir da API é necessário estar autenticado.",
  "docs": "https://api.faladevs.com/v1/docs",
  "support": "contato@faladevs.com"
}

Limite do plano atingido


{
  "message": "Limite do plano atingido! Assine um plano, ou faça um Upgrade para aumentar seu limite de requisições mensais.",
  "support": "contato@faladevs.com"
}

CPF - Cadastro de Pessoa Física

Com este endpoint você será capaz de gerar números de CPF, além de validar. Fique atento aos retornos de erros para que sejam tratados na sua aplicação da forma correta.

Gerando um número de CPF

https://api.faladevs.com/v1/cpf 

{
  "number": "10836759583",
  "number_formatted": "108.367.595-83",
  "status": true,
  "message": "CPF válido."
}

Validando um número de CPF

https://api.faladevs.com/v1/cpf/{cpf}

Tipo do parâmetro CPF: int


{
  "number": "10836759583",
  "number_formatted": "108.367.595-83",
  "status": true,
  "message": "CPF válido."
}

Mensagens de erro

Você receberá as mensagens de erro nas seguintes situações de validação:

CPF inválido


{
  "number": "10886759583",
  "number_formatted": "108.867.595-83",
  "status": false,
  "message": "CPF inválido."
}

Quantidade de digitos incorretos


{
  "number": "1083675583",
  "status": false,
  "message": "CPF inválido. O CPF deve possuir 11 digitos."
}

Todos os digitos são iguais


{
  "number": "11111111111",
  "number_formatted": "111.111.111-11",
  "status": false,
  "message": "CPF inválido. Os digitos do CPF não podem ser iguais."
}

CNPJ - Cadastro Nacional de Pessoa Jurídica

Com este endpoint você será capaz de gerar números de CNPJ, além de validar. Fique atento aos retornos de erros para que sejam tratados na sua aplicação da forma correta.

Gerando um número de CNPJ

https://api.faladevs.com/v1/cnpj 

{
  "number": "29220265000187",
  "number_formatted": "29.220.265/0001-87",
  "status": true,
  "message": "CNPJ válido."
}

Validando um número de CNPJ

https://api.faladevs.com/v1/cnpj/{cnpj}

Tipo do parâmetro CNPJ: int


{
  "number": "29220265000187",
  "number_formatted": "29.220.265/0001-87",
  "status": true,
  "message": "CNPJ válido."
}

Mensagens de erro

Você receberá as mensagens de erro nas seguintes situações de validação:

CNPJ inválido


{
  "number": "29220265000187",
  "number_formatted": "29.220.265/0001-87",
  "status": false,
  "message": "CNPJ inválido."
}

Quantidade de digitos incorretos


{
  "number": "292202650018",
  "status": false,
  "message": "CNPJ inválido. O CNPJ deve possuir 14 digitos."
}

Todos os digitos são iguais


{
  "number": "11111111111111",
  "number_formatted": "11.111.111/1111-11",
  "status": false,
  "message": "CNPJ inválido. Os digitos do CNPJ não podem ser iguais."
}

Regiões do Brasil - Regiões, Cidades, Estados

Com este endpoint você será capaz de listar as regiões do Brasil. Fique atento aos retornos de erros para que sejam tratados na sua aplicação da forma correta.

Regiões

https://api.faladevs.com/v1/regioes 

{
  "data":[
    {
      "id": 2,
      "name": "Nordeste",
      "abbreviation": "No",
      "denomination": "Nordestino"
    },
    ...
  ]
}

Estados Brasileiros

https://api.faladevs.com/v1/estados 

{
  "data":[
    {
      "id": 13,
      "name": "Mato Grosso",
      "uf": "MT",
      "denomination": "Mato-Grossense",
      "flag": "https://api.faladevs.com/assets/bandeiras/MT.png",
      "flag_origin": "A bandeira mato-grossense conta com as mesmas cores em relação à bandeira brasileira. Dessa forma, simboliza a integração do Estado à Nação."
    },
    ...
  ]
}

Estado Brasileiro por UF

https://api.faladevs.com/v1/estados/{uf} 

{
  "data":[
    {
      "id": 13,
      "name": "Mato Grosso",
      "uf": "MT",
      "denomination": "Mato-Grossense",
      "flag": "https://api.faladevs.com/assets/bandeiras/MT.png",
      "flag_origin": "A bandeira mato-grossense conta com as mesmas cores em relação à bandeira brasileira. Dessa forma, simboliza a integração do Estado à Nação."
    }
  ]
}

Cidades por Estado

https://api.faladevs.com/v1/cidades/{uf} 

{
  "data":[
    {
      "id": 758,
      "name": "Frecheirinha",
      "uf": "CE",
      "state": "Ceará"
    },
    ...
  ]
}

Perguntas Frequentes

Antes de entrar em contato, verifique se a sua dúvida já foi respondida abaixo:

A API é gratuita?

Sim, a API é gratuita e sempre será.

A API possui limite de requisições?

Sim, você poderá fazer até 3.000 requisições mensais gratuitamente em nossa API, porém também possuímos planos mensais caso deseje ajudar o projeto e aumentar seu limite de requisições mensais entre em contato através do email contato@faladevs.com. Se o aplicativo exceder o limite de requisições de acordo com o plano escolhido, você receberá um retorno na API informando que o limite foi atingido.