{"openapi":"3.0.3","info":{"title":"Zinix API de Placa e FIPE","version":"1.0.0","description":"Consulte dados veiculares e FIPE por placa. Cada cliente possui sua credencial Bearer e identificador. Toda consulta de placa v\u00e1lida \u00e9 registrada, inclusive quando respondida pelo cache. O consumo diferencia sucessos, ve\u00edculos n\u00e3o encontrados e falhas. Consultar o consumo n\u00e3o registra uma consulta de placa."},"servers":[{"url":"https:\/\/apiplaca.zinix.com.br"}],"security":[{"bearerAuth":[]}],"paths":{"\/v1\/vehicles\/{plate}":{"get":{"operationId":"lookupVehicle","summary":"Consulta dados do ve\u00edculo, FIPE e hist\u00f3rico de valores pela placa.","parameters":[{"name":"plate","in":"path","required":true,"schema":{"type":"string","example":"ABC1D23"},"description":"Placa brasileira no padr\u00e3o antigo ou Mercosul. Aceita letras min\u00fasculas e h\u00edfen."}],"responses":{"200":{"description":"Consulta conclu\u00edda. O conte\u00fado de data segue a resposta veicular\/FIPE do servi\u00e7o j\u00e1 utilizado pela Zinix. Os campos dispon\u00edveis variam por ve\u00edculo.","content":{"application\/json":{"schema":{"type":"object","required":["request_id","client_id","plate","data"],"properties":{"request_id":{"type":"string","format":"uuid"},"client_id":{"type":"string","example":"minha-loja"},"plate":{"type":"string"},"data":{"type":"object","properties":{"informacoes_veiculo":{"type":"object","additionalProperties":true},"fipe":{"type":"array","items":{"type":"object","additionalProperties":true}}},"additionalProperties":true},"desvalorizometro":{"type":"object","nullable":true,"additionalProperties":true}}}}}},"400":{"$ref":"#\/components\/responses\/Invalid"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"description":"Placa n\u00e3o encontrada. error.code = vehicle_not_found."},"502":{"description":"Falha tempor\u00e1ria no servi\u00e7o de consulta. error.code = provider_unavailable."},"503":{"description":"Limite do provedor atingido. error.code = provider_limit."}}}},"\/v1\/usage":{"get":{"operationId":"getUsage","summary":"Consulta o consumo do cliente da credencial.","parameters":[{"name":"month","in":"query","schema":{"type":"string","pattern":"^[0-9]{4}-(0[1-9]|1[0-2])$","example":"2026-11"},"description":"Compet\u00eancia AAAA-MM. O padr\u00e3o \u00e9 o m\u00eas atual, com fechamento em America\/Sao_Paulo."}],"responses":{"200":{"description":"Consumo isolado por cliente, somando todas as suas credenciais. total \u00e9 acumulado e period \u00e9 o m\u00eas solicitado. consultations inclui placas v\u00e1lidas. successful informa as consultas com retorno de ve\u00edculo. requests inclui tamb\u00e9m placas inv\u00e1lidas. pending identifica chamadas ainda em processamento.","content":{"application\/json":{"example":{"request_id":"a5a9ed8e-62f0-4ae6-b13c-972219411305","client_id":"minha-loja","data":{"month":"2026-11","timezone":"America\/Sao_Paulo","total":{"requests":12,"consultations":11,"successful":10,"not_found":1,"failed":0,"invalid":1,"pending":0},"period":{"requests":12,"consultations":11,"successful":10,"not_found":1,"failed":0,"invalid":1,"pending":0}}}}}},"400":{"$ref":"#\/components\/responses\/Invalid"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/health":{"get":{"security":[],"summary":"Sa\u00fade da API.","responses":{"200":{"description":"API dispon\u00edvel."}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Credencial exclusiva da API de placas. Envie Authorization: Bearer SUA_CREDENCIAL."}},"responses":{"Invalid":{"description":"Par\u00e2metro inv\u00e1lido. error.code = invalid_plate ou invalid_month."},"Unauthorized":{"description":"Credencial inv\u00e1lida, revogada ou cliente inativo. error.code = invalid_credential."}}}}