Folha de Frota API

API ID 14793

API de decodificador de VIN em lote decode até 25 VINs por chamada contra o banco de dados NHTSA vPIC com registros por VIN flags de qualidade de dados e um resumo da frota

2,555 ms resp. média

Documentação da API

Endpoints

Requisição
{"vins": ["...", ...]}, 1 a 25 strings VIN (completo 17-caracteres ou parcial 5-17 caracteres). Retorna contagem, resumo (total / decodificado / esparso / falhou / checksumSuspect / coberturaCampo / detalhamento por marca, classe de carroceria e tipo de combustível) e resultados na ordem do pedido. Exemplo (abreviado de uma resposta real de produção): {"count": 3, "summary": {"total": 3, "decoded": 2, "sparse": 1, "failed": 0, "checksumSuspect": 1, "fieldCoverage": {"make": 3, "model": 2, "modelYear": 2, "bodyClass": 2, "fuelTypePrimary": 2}, "breakdown": {"byMake": {"HONDA": 2, "FORD": 1}, "byBodyClass": {"Coupe": 1, "Pickup": 1}, "byFuelTypePrimary": {"Gasoline": 2}}}, "results": [{"vin": "1HGCM82633A004352", "ok": true, "vehicle": {"vin": "1HGCM82633A004352", "make": "HONDA", "model": "Accord", "modelYear": "2003", "errorCode": "0"}}, {"vin": "1HGCM", "ok": true, "vehicle": {"vin": "1HGCM", "make": "HONDA", "model": null, "modelYear": null, "errorCode": "6,8,11"}}]}
Endpoint ID: 38337
POST https://zylalabs.com/api/14793/fleet+sheet+api/38337/post+decode+batch
PARÂMETROS DE ENTRADA

decodificar lote POST — Recursos do endpoint

Objeto Descrição
Corpo da requisição Obrigatório Json

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

RESPOSTA DE EXEMPLO DA API
JSON
{
    "count": 2,
    "summary": {
        "total": 2,
        "decoded": 1,
        "sparse": 1,
        "failed": 0,
        "checksumSuspect": 0,
        "fieldCoverage": {
            "make": 2,
            "model": 1,
            "modelYear": 1,
            "bodyClass": 1,
            "fuelTypePrimary": 1
        },
        "breakdown": {
            "byMake": {
                "HONDA": 2
            },
            "byBodyClass": {
                "Coupe": 1
            },
            "byFuelTypePrimary": {
                "Gasoline": 1
            }
        }
    },
    "results": [
        {
            "vin": "1HGCM82633A004352",
            "ok": true,
            "vehicle": {
                "vin": "1HGCM82633A004352",
                "make": "HONDA",
                "model": "Accord",
                "modelYear": "2003",
                "trim": "EX-V6",
                "series": null,
                "bodyClass": "Coupe",
                "vehicleType": "PASSENGER CAR",
                "manufacturer": "AMERICAN HONDA MOTOR CO., INC.",
                "driveType": null,
                "transmissionStyle": "Automatic",
                "transmissionSpeeds": "5",
                "fuelTypePrimary": "Gasoline",
                "fuelTypeSecondary": null,
                "engineCylinders": "6",
                "engineHP": "240",
                "displacementL": "2.998832712",
                "doors": "2",
                "plantCity": "MARYSVILLE",
                "plantState": "OHIO",
                "plantCountry": "UNITED STATES (USA)",
                "errorCode": "0",
                "errorText": "0 - VIN decoded clean. Check Digit (9th position) is correct"
            }
        },
        {
            "vin": "1HGCM",
            "ok": true,
            "vehicle": {
                "vin": "1HGCM",
                "make": "HONDA",
                "model": null,
                "modelYear": null,
                "trim": null,
                "series": null,
                "bodyClass": null,
                "vehicleType": "PASSENGER CAR",
                "manufacturer": "AMERICAN HONDA MOTOR CO., INC.",
                "driveType": null,
                "transmissionStyle": null,
                "transmissionSpeeds": null,
                "fuelTypePrimary": null,
                "fuelTypeSecondary": null,
                "engineCylinders": null,
                "engineHP": null,
                "displacementL": null,
                "doors": null,
                "plantCity": null,
                "plantState": null,
                "plantCountry": null,
                "errorCode": "6,8,11",
                "errorText": "6 - Incomplete VIN; 8 - No detailed data available currently; 11 - Incorrect Model Year - Position 10 does not match valid model year codes (I, O, Q, U, Z, 0). Decoded data may not be accurate."
            }
        }
    ],
    "sources": [
        "NHTSA vPIC"
    ],
    "_attribution": "Data from the U.S. National Highway Traffic Safety Administration (NHTSA) Vehicle Product Information Catalog (vPIC), https://vpic.nhtsa.dot.gov. Reference data only; not a substitute for manufacturer or title records."
}
Decodificar lote POST — TRECHOS DE CÓDIGO

curl --location --request POST 'https://zylalabs.com/api/14793/fleet+sheet+api/38337/post+decode+batch' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{"vins": ["1HGCM82633A004352", "1HGCM"]}'

    
Requisição
decodificação única (VIN necessário, 5-17 caracteres); mesmo motor, mesmos campos que uma linha de lote. Campos de decodificação única ao vivo incluem trim, série, classe de carroceria, tipo de veículo, fabricante, estilo de transmissão/velocidades, tipo de combustível primário, cilindrada do motor, HP do motor, deslocamento L, portas, cidade/estado/país da fábrica, código de erro e texto de erro, além de fontes e atribuição nomeando NHTSA vPIC
Endpoint ID: 38338
GET https://zylalabs.com/api/14793/fleet+sheet+api/38338/get+decode+vin
PARÂMETROS DE ENTRADA

obter decodificar vin — Recursos do endpoint

Objeto Descrição
vin Obrigatório VIN to decode, 5-17 characters

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

vin
RESPOSTA DE EXEMPLO DA API
JSON
{
    "vehicle": {
        "vin": "1HGCM82633A004352",
        "make": "HONDA",
        "model": "Accord",
        "modelYear": "2003",
        "trim": "EX-V6",
        "series": null,
        "bodyClass": "Coupe",
        "vehicleType": "PASSENGER CAR",
        "manufacturer": "AMERICAN HONDA MOTOR CO., INC.",
        "driveType": null,
        "transmissionStyle": "Automatic",
        "transmissionSpeeds": "5",
        "fuelTypePrimary": "Gasoline",
        "fuelTypeSecondary": null,
        "engineCylinders": "6",
        "engineHP": "240",
        "displacementL": "2.998832712",
        "doors": "2",
        "plantCity": "MARYSVILLE",
        "plantState": "OHIO",
        "plantCountry": "UNITED STATES (USA)",
        "errorCode": "0",
        "errorText": "0 - VIN decoded clean. Check Digit (9th position) is correct"
    },
    "sources": [
        "NHTSA vPIC"
    ],
    "_attribution": "Data from the U.S. National Highway Traffic Safety Administration (NHTSA) Vehicle Product Information Catalog (vPIC), https://vpic.nhtsa.dot.gov. Reference data only; not a substitute for manufacturer or title records."
}
Obter decodificar vin — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/14793/fleet+sheet+api/38338/get+decode+vin?vin=1HGCM82633A004352' --header 'Authorization: Bearer YOUR_API_KEY' 


    

Chave de acesso à API e autenticação

Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Folha de Frota API basta incluir seu token Bearer no cabeçalho Authorization.

Cabeçalhos
Cabeçalho Descrição
Authorization Obrigatório Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.

Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento.

A partir de
$10.000/Ano


  • Volume personalizado
  • Limite de taxa personalizado
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real

Visão Geral

API de decodificador de VIN em lote: decodifique até 25 VINs por chamada contra o banco de dados vPIC da NHTSA, com registros por VIN, sinalizações de qualidade de dados e um resumo da frota

Folha de Frota API FAQs

Cada VIN é decodificado ao vivo contra o NHTSA vPIC, o banco de dados federal de veículos dos EUA. Cada resposta de dados inclui fontes e campos de atribuição nomeando o provedor

VPIC sinaliza os VINs cujo dígito de verificação na 9ª posição não é calculado corretamente com o código de erro 1. O FleetSheet espelha essa sinalização por registro e os conta no resumo. Um VIN sinalizado ainda retorna seu registro completo decodificado - a sinalização é um incentivo para verificar aquele VIN com sua documentação, não uma rejeição

Cada linha ruim volta em sua própria linha com um código de erro (INVALID_VIN, MISSING_PARAM, …) e o restante do lote decodifica normalmente Lotes com mais de 25 VINs são rejeitados inteiros com BATCH_TOO_LARGE - divida frotas maiores em pedaços de 25

Sim O endpoint em lote aceita VINs completos de 17 caracteres ou VINs parciais de 5 a 17 caracteres VINs parciais retornam os campos que o vPIC pode resolver e contam como registros esparsos no resumo

Nesta API cada VIN no lote conta como uma solicitação contra sua cota do plano então um lote completo de 25 VIN conta como 25 solicitações

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.
Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]

Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.
A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.
Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]
Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.
As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.
O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.
Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.
Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.
Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.
O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.
Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.
Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.
Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.
Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.
As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.
Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]