erodrigues-developer/placa-fipe-api

Placa Fipe API

Placa Fipe API é um componente que permite a consulta da situação de um veículo pela placa. Devolve também o cadastro correspondente ao modelo do veículo na tabela Fipe.

API Modules (PHP):

Instalação
Pesquisar()
Registrar()
Autenticar()

Instalação

Dependência: cURL library --> http://php.net/curl

Copiar o arquivo cs_api.php para o seu sistema. Alterar a propriedade privada $authToken com o seu token de acesso. Para gerar um token gratuito de testes, seguir os passos no final deste documento.

Pesquisar

require "cs_api.php";

$CsApi = new CSAPI();

$success = $CsApi->Pesquisar("AAA-9999"); 

if($success == false){
    echo $CsApi->Erro();
    return;
}

echo $CsApi->Retorno();

Layout:

{
    "erro": "",
    "situacao": "Sem restrição",
    "modelo": "Modelo Teste",
    "marca": "Marca do Carro",
    "cor": "Preta",
    "ano": "2010",
    "anoModelo": "2010",
    "placa": "AAA9999",
    "uf": "SP",
    "municipio": "SAO PAULO",
    "chassi": "55555",
    "versao": "3.2 V6",
    "fipe": {
        "status": "OK",
        "versao_depara": "",
        "veiculos": [
            {
                "modelo": "Modelo fipe",
                "versao": "3.2 V6 V6 Tronic",
                "codigo_fipe": "056012-0",
                "ano_modelo": "2010",
                "combustivel": "Gasolina",
                "combustivel_versao": "Gasolina",
                "valor": "83907.00",
                "portas": "2P",
                "cambio": "Automático"
            }
        ]
    }
}

Caso o veículo não seja localizado na tabela Fipe, o retorno da propriedade "Fipe"->"status" será NOK

    "fipe": {
            "status": "NOK"
            ...
    }
 }

Erros:

{"erro":"Acesso negado"} O Token não é válido
{"erro":"Atingiu o limite de [quantiade limite] consultas"} Excedeu o limite de consultas permitidas no mês para o plano

Os exemplos podem ser encontados no arquivo consumo_api.php.

Token

Registrar()

Para gerar um token, é necessário criar uma conta informando usuário e senha de livre ecolha. A API irá devolver um token que permite a autenticação necessária para realizar a consulta de placas.

O token gerado é de uma conta gratuita e permite 50 consultas por mês.

Por enquanto o sistema só oferece a opção de conta gratuita. Para obter uma conta com um limite maior de consultas, iremos disponibilizar em breve os planos.

require "cs_api.php";
$CsApi = new CSAPI();

$success = $CsApi->Registrar("email@teste.com", "senha123"); 

if(!$success){
    echo $CsApi->Erro();
    return;
}

echo $CsApi->Token();

Retorno:

$2a$08$Cf1f11ePArKlBJomM0F6a.u0Tq9FigSP8n7rwbbLgmW.R6ekqmgWe Colocar a chave gerada na variável $authToken em cs_api.php

Usuário já existente - Dados não foram suficientes para autenticar, mas o usuário (email) já existe

Autenticar()

No método Registrar(), Caso o usuário já exista e a autenticação for positiva, a API irá devolver o token.

Utilizar o método Autenticar() para obter o token de um usuário já existente;

$CsApi->Autenticar("email@teste.com", "senha123"); 
echo $CsApi->Token();

erodrigues-developer / placa-fipe-api