{
"openapi": "3.0.0",
"info": {
"title": "API DESPACHANTE DOK",
"description": "API exclusiva para alguns serviços DOK, como Despachante, ANTT, etc...",
"contact": {
"email": "admin@admin.com"
},
"version": "1.0.0"
},
"servers": [
{
"url": "http://my-default-host.com",
"description": ""
},
{
"url": "https://dok.local//"
}
],
"paths": {
"api/despachante/debito/orcamento/gerar": {
"post": {
"tags": [
"Despachante/Débitos"
],
"summary": "Gera o orçamento dos débitos",
"description": "Gera o orçamento dos débitos do veículo informado.
Os campos tipo_veiculo_id e cidade_destino_id serão enviados para a geração de orçamento de transferência. Caso tenha verificado que o veículo precisa fazer a transferência, o cliente poderá apenas consultar os débitos desse veículo, nesse caso será necessário enviar o campo forcar_debitos.
Quando o código do retorno for 206, quer dizer que será necessário fazer a transferência, nesse caso precisará enviar os campos citados acima. ",
"operationId": "debitosGerarOrcamento",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"requestBody": {
"description": "Informa os dados do veículo",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"identificador",
"email"
],
"properties": {
"identificador": {
"type": "string",
"example": "AAA0000 / 1111111111"
},
"email": {
"type": "string",
"example": "email@email.com"
},
"adicionar_veiculo_placa": {
"type": "integer",
"example": "0 / 1"
},
"servico_tipo_nome": {
"type": "string",
"example": "licenciamento_online/debitos_online/transferencia"
},
"tipo_veiculo_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"cidade_destino_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"forcar_debitos": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Orçamento gerado com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"checkout_orcamento_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
}
}
},
"type": "object"
}
}
}
},
"202": {
"description": "Não há débitos para o veículo informado",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Parabéns! Seu documento está em dia. :)"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"tipo": "aviso-consulta",
"titulo": "Documento OK"
}
}
},
"type": "object"
}
}
}
},
"206": {
"description": "Foi constatado que é necessário efetuar a trasnferência do veículo primeiro",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "O veículo consultado consta com transferência"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"tipo": "consulta-transferencia",
"tipo_servico_nome": "transferencia"
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"422": {
"description": "Erro de validação"
},
"418": {
"description": "Erros diversos",
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"properties": {
"message": {
"type": "string",
"example": "Já existe um pedido em andamento para essa Placa ou Renavam. / Você também pode tentar consultar seus débitos com o número do Renavam do seu veículo. / O sistema do DETRAN está fora do ar! / Não foi possivel fazer a consulta! / Não conseguimos consultar os débitos com este número de Renavam. Por favor, tente novamente com a placa do veículo. / Você também pode tentar consultar seus débitos com o número do Renavam do seu veículo."
}
},
"type": "object"
},
"data": {
"properties": {
"tipo": {
"type": "string",
"example": "erro-placa / erro-consulta / erro-detran-fora / erro-pedido / erro-outro-estado"
},
"titulo": {
"type": "string",
"example": "Título do erro, uma breve descrição do erro para quando houver mais de uma mensagem"
},
"despachante_pedido_id": {
"type": "string",
"example": "ID do pedido caso o já exista um pedido em aberto para a placa informada"
},
"cliente_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"estados": {
"type": "object",
"example": [
{
"id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"nome": "Acre",
"sigla": "AC"
},
{
"id": "Zkh0WDJTcjNWT2pMbHBXL29jNWZYZz09",
"nome": "Alagoas",
"sigla": "AL"
}
]
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"api/despachante/documento-digital/consultar": {
"get": {
"tags": [
"Despachante/Documentos"
],
"summary": "Consulta um documento digital",
"description": "Consulta um documento digital pelo id do despachante pedido informado",
"operationId": "documentoDigitalConsultar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
},
{
"name": "despachante_pedido_id",
"in": "path",
"description": "Informa o id do despachante pedido",
"required": true,
"example": "api/despachante/documento-digital/consultar/99"
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Documento digital consultado com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"documento": "JVBERi0xLjcNCiWhs8XXDQoxIDAgb2JqDQo8PC9QYWdlcyAyIDAgUiAvVHlwZS9DYXRhbG9nPj4NCmVuZG9iag0KMiAwIG9iag0KPDwvQ291bnQgMS9LaWRzWyA0IDAgUiBdL1R5cGUvUGFnZXM+Pg0KZW5kb2JqDQozIDAgb2JqDQo8PC9DcmVhdGlvbkRhdGUoRDoyMDIxMDcxMjEwMDQ1MikvQ3JlYXRvcihQREZpdW0pL1Byb2R1Y2VyKFBERml1bSk+PDQyNjVERkEwMjY1ODFBRTgwMDI2REQwN0Y3RTMxNDMzPl0+Pg0Kc3RhcnR4cmVmDQo3OTc1MA0KJSVFT0YNCg=="
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/documento-digital/listar": {
"get": {
"tags": [
"Despachante/Documentos"
],
"summary": "Lista os documentos digitais",
"description": "Lista os documentos digitais pelo id do cliente informado",
"operationId": "documentoDigitalListar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
},
{
"name": "cliente_id",
"in": "path",
"description": "Informa o id do cliente",
"required": true,
"example": "api/despachante/documento-digital/listar/YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Documentos digitais listados com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"documentos": [
{
"vencimento": "2022-12-12 00:00:00",
"cliente_veiculo_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"placa": "AAA0000",
"renavam": "111111111",
"ano_fabricacao": "2001",
"modelo": "MODELO DO CARRO",
"despachante_pedido_id": 99,
"ultimo_licenciamento": 2021
}
]
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/outros-servicos/debito/orcamento/gerar": {
"post": {
"tags": [
"Despachante/Outros serviços"
],
"summary": "Gera o orçamento dos débitos",
"description": "Gera o orçamento dos débitos do veículo informado",
"operationId": "outrosServicosDebitosGerarOrcamento",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"requestBody": {
"description": "Informa os dados do veículo",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"identificador",
"email",
"nome",
"servico_tipo_nome"
],
"properties": {
"identificador": {
"type": "string",
"example": "AAA0000 / 1111111111"
},
"email": {
"type": "string",
"example": "email@email.com"
},
"nome": {
"type": "string",
"example": "Nome Cliente"
},
"tipo_identificador": {
"type": "string",
"example": "placa / renavam"
},
"telefone": {
"type": "string",
"example": "(11)11111-1111"
},
"servico_tipo_nome": {
"type": "string",
"example": "licenciamento_online/primeiro_emplacamento/transferencia/regularizacao_motor/regularizacao_carro_rebaixado/segunda_via_crv/segunda_via_crlv/antt"
},
"cidade_id": {
"type": "integer",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"estado_id": {
"type": "integer",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"tipo_veiculo_id": {
"type": "integer",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"valor_nota": {
"type": "decimal",
"example": 999.99
},
"data_nota": {
"type": "string",
"example": "11/11/1111"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Orçamento gerado com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"checkout_orcamento_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
}
}
},
"type": "object"
}
}
}
},
"202": {
"description": "Não há débitos para o veículo informado",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Parabéns! Seu documento está em dia. :)"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"422": {
"description": "Erro de validação"
},
"418": {
"description": "Erros diversos",
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"properties": {
"message": {
"type": "string",
"example": "Já existe um pedido em andamento para essa Placa ou Renavam. / Você também pode tentar consultar seus débitos com o número do Renavam do seu veículo. / O sistema do DETRAN está fora do ar! / Não foi possivel fazer a consulta! / Não conseguimos consultar os débitos com este número de Renavam. Por favor, tente novamente com a placa do veículo. / Você também pode tentar consultar seus débitos com o número do Renavam do seu veículo."
}
},
"type": "object"
},
"data": {
"properties": {
"tipo": {
"type": "string",
"example": "erro-placa / erro-consulta / erro-detran-fora / erro-pedido / erro-outro-estado"
},
"titulo": {
"type": "string",
"example": "Título do erro, uma breve descrição do erro para quando houver mais de uma mensagem"
},
"pedido": {
"type": "string",
"example": "ID do pedido caso o já exista um pedido em aberto para a placa informada"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"api/despachante/pedido/consultar": {
"get": {
"tags": [
"Despachante/Pedidos"
],
"summary": "Consulta um pedido",
"description": "Consulta um pedido pelo id do despachante pedido informado",
"operationId": "pedidoConsultar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
},
{
"name": "despachante_pedido_id",
"in": "path",
"description": "Informa o id do despachante pedido",
"required": true,
"example": "api/despachante/pedido/consultar/99"
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Pedido consultado com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"id": 99,
"checkout_pedido_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"placa": "AAA0000",
"despachante_orcamento_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"entrega_nome": "Nome Cliente",
"entrega_logradouro": "Rua Imperatriz Leopoldina",
"entrega_numero": 1,
"entrega_cep": "18044-010",
"entrega_bairro": "Vila Jardini",
"entrega_cidade": "Sorocaba",
"entrega_estado": "SP",
"codigo_rastreio": null,
"checkout_forma_entrega_nome": "digital",
"checkout_forma_entrega_descricao": "Digital",
"checkout_forma_pagamento_nome": "boleto_cartao",
"checkout_pedido_status_nome": "pendente",
"checkout_pedido_status_descricao": "Pendente",
"valor_frete": 999.99,
"valor_desconto": 999.99,
"valor_total": 999.99,
"valor_despachante": 999.99,
"despachante_documento_digital_id": null,
"servico_tipo_nome": "licenciamento_online",
"servico_tipo_descricao": "Licenciamento Online",
"debitos_formatados": [
{
"descricao": "Licenciamento 2021",
"valor": 98.91
},
{
"descricao": "IPVA 2021",
"valor": 98.91
}
],
"data_formatada": "1999-12-01 00:00:00",
"pagamentos": [
{
"bandeira": "bolbradesco",
"parcelas": null,
"valor_parcela": null,
"valor": 999.99,
"cartao_numero_fim": null,
"url_boleto": "https://mercadopago.com.br/#1265453asde",
"qr_code_texto": null,
"qr_code_imagem": null
},
{
"bandeira": "visa",
"parcelas": 2,
"valor_parcela": 999.99,
"valor": 999.99,
"cartao_numero_fim": 1234,
"url_boleto": null,
"qr_code_texto": null,
"qr_code_imagem": null
},
{
"bandeira": "pix",
"parcelas": null,
"valor_parcela": null,
"valor": 999.99,
"cartao_numero_fim": null,
"url_boleto": null,
"qr_code_texto": "00020126330014br.gov.bcb.pix011112918314609520400005303986540510.005802BR5910Terrasys576006recife62230519mpqrinter124428655863045A38",
"qr_code_imagem": "iVBORw0KGgoAAAANSUhEUgAABMQAAATEAQAAAACsS+RXAAAIW0lEQVR42u3dQXLqOBAGYLHiGBwVH5UjzJIVmnk1CahbbXAwqXqLzysKHOtzVl2qX92t/6XXP42MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjOz3ZEsL1+HPN6d+/fOh90s7Pu68/X/H1zeX9Zsv4z3/XefHh/7fzfE6kZGRkZGRkZGRke2WDb99rTH8/fEP6P7o+zf36/xNvP/58njDr9dYHs8ZlphXJyMjIyMjIyMjI3tbdv0ufIc/+wIdHx/iVYHizcOT21htRz0ZGRkZGRkZGRnZ78jum8Lt8aAWVp0L8fCcFmrrS6q2ycjIyMjIyMjIyH5VFqrkWGQv5Z5y3C9OT74vT0ZGRkZGRkZGRvaLspiKGL7Je8HnIuDb04f7qnOR3XfmNcjIyMjIyMjIyMhq2erptV/68IFzdWRkZGRkZGRkZGQbrtvQQGH4MKQiWn3UrdpTvnz/dHq6JhkZGRkZGRkZGdl7skuqf8+PB4Xswi3sILciFdFCSX3+fsM2piJ6IC5Pq20yMjIyMjIyMjKyLbKqk0KbDpvlVEToyBCXb7EQL9uNDTeTkZGRkZGRkZGR7Zedpv4Lp9RJoeqTe0nfLEUBXW0c5zRwJyMjIyMjIyMjI9spCxmIeVd35dRZSk4c1p8zzkUbyu6wy0xGRkZGRkZGRka2T5YzEGFY70oz3KVsj7sSoQitGfo0MYKMjIyMjIyMjIzsE7K5OL5NAx5ywHfukxuL7BALPk6R3+vrjgxkZGRkZGRkZGRkW2TLtOq5PM82NAW7Ddb0nPIUXKrIWz0GmIyMjIyMjIyMjOxNWS/CEIMjR37riby9Cu/OpXk4Kbcx6UtGRkZGRkZGRka2RXYN/cL6lGZI+8XjLnPaC44/VUfdjsV2MxkZGRkZGRkZGdke2VIcLWtjAZ13kGOaYSipT0UJnyvyQd/ShGAyMjIyMjIyMjKyXbLYSqxP4xza9OjTONisDzX6ElMR80/xnk5GRkZGRkZGRkb2AVn1oHzF+btJ38OhtSoV0aaxEO316TUyMjIyMjIyMjKyLbKqp1g1kOya1pgjvzPxMpbUc5ex25bOuWRkZGRkZGRkZGSvZRWoTcN684Mu5XZzLrurV83/DjIyMjIyMjIyMrL9spWgw9CA7DQtX59nW9mS7uvPOZGRkZGRkZGRkZHtlC3xQNotbfhepzV6Sk6cxucchg8BNKeKN/b0JSMjIyMjIyMjI/vBDnIY8LA6oqzqKdan8O5Ke9xcf5ORkZGRkZGRkZHtl90zEL3c8M3B3MsYmIgH0k7FYvMwidhljIyMjIyMjIyMjOwTsnB3q0vqUyrNz72aIVH12z2Egj4sQUZGRkZGRkZGRvYRWUj65vo753pDhOI6rXp8lObx5jZW26ulORkZGRkZGRkZGdlbsqU4qxbmQ4xbwOfYVDfmei9lH4c+/ZT3ncnIyMjIyMjIyMj2y1pxxqyneWZzhCLuDp+n6MO5z6fX6iXIyMjIyMjIyMjI9sjmabtDJZ0d86SHFjMQ+Xo6Mm3DnAoyMjIyMjIyMjKy17JldOQK+PJYdV4jZiD6NM+slc3F5mKdjIyMjIyMjIyMbK8sh3dD0jcnHnJFXrfQvV/XcIwtvPOGapuMjIyMjIyMjIxsi2y+KYUYcr6hakA2PmfYOK66jK0MiiAjIyMjIyMjIyP7hKwqqY9TwPf4csTvnIp40oq3k5GRkZGRkZGRke2ULXFYb6/2eVMv3VhJ99RkIeUtysjvuQ8deMnIyMjIyMjIyMg+JhuyC69nlbUxDHEbsr/DebYQqmhV9peMjIyMjIyMjIxsv6w+ojbv/MYt4Po6FknfQ3CEjeM8O42MjIyMjIyMjIzsTVk4Y9ZSudzDg+47v6G2nnMScY5vj/vFOfJLRkZGRkZGRkZGtleWj5+dY+Jhbqlwm/ov3Kpqexh11lMsuG9JRZCRkZGRkZGRkZFtk1WNw3JtPTw6LFbmJM7FG+YuYxvzGmRkZGRkZGRkZGTb8rS58F2KKQ6nKR7Rphm9l/H02vxi5TtvTEWQkZGRkZGRkZGRPZEtY5W8OgQiy8Kfx1TEeWxbNkeHh3jxptlrZGRkZGRkZGRkZFtm4/ZpMzeX1E/0fQL1lIpYa9bwstomIyMjIyMjIyMj++EO8mVcfuzRsBS53lPRbaEV/RfK/0KI/JKRkZGRkZGRkZHtky2xB+5cJfewlVz1FKtCFbcqDXzuVWsGMjIyMjIyMjIysr2y05SBmI+xXcrWtz2smvWhWK+Oum1IRZCRkZGRkZGRkZH9IOnb4u5wS1vA1+KeQ70TPaciqj4O7QddxsjIyMjIyMjIyMhepCJiwLc/quRcEw/Tyy7tyRXr72oD+lQtT0ZGRkZGRkZGRrZbNlfJFfpWHWNLgyLmVmK3KXhxSCN+ycjIyMjIyMjIyN6SLbFOLo+fheZicS84bROXqYgebz6stYEgIyMjIyMjIyMje1OWS+plPLR2nAroXH/31Ers/Dxv8ZNqm4yMjIyMjIyMjGyrbC6Xj3O7hOnU2TXU6OlVb6FbWVXZH7d1ZCAjIyMjIyMjIyN7RxYefZgq8pZaM1ynvmPxyfPMs6U8/EZGRkZGRkZGRkb2MVlLvcCWcXc453rbFH14kYpoKShMRkZGRkZGRkZGtl/2JBURW+jO8YhQmg+piPGbVIjHQRFkZGRkZGRkZGRk+2X59Foqjg/p5mr58lWXlVBFqwITZGRkZGRkZGRkZG/L/qaLjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIzsw7J/ARSPnic1ZqbEAAAAAElFTkSuQmCC"
}
],
"linha_tempo": [
{
"status": "ativo",
"titulo": "Pedido realizado",
"descricao": "Seu pedido passará pela análise do banco.",
"data": "Seg, 17/Jan"
},
{
"status": "analise",
"titulo": "Pagamento dos débitos",
"descricao": "Os pagamentos dos débitos serão pagos aos órgãos do governo.",
"data": ""
},
{
"status": "aberto",
"titulo": "Emissão do documento",
"descricao": "Seu novo documento digital será emitido.",
"data": ""
},
{
"status": "aberto",
"titulo": "Envio do documento digital",
"descricao": "O documento em PDF será enviado por e-mail e também ficará disponível no site e aplicativo",
"data": ""
}
]
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Não foi possível consultar o pedido"
}
}
}
},
"api/despachante/pedido/listar/guias": {
"get": {
"tags": [
"Despachante/Pedidos"
],
"summary": "Lista as guias",
"description": "Lista as guias de um pedido",
"operationId": "pedidoGuiaListar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
},
{
"name": "despachante_pedido_id",
"in": "path",
"description": "Informa o id do despachante pedido",
"required": true,
"example": "api/despachante/pedido/listar/guias/99"
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Guias listadas com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"guias": [
{
"nome": "Licenciamento",
"guia": "https://urldaguia.com.br/"
}
]
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Não foi possível listar as guias"
}
}
}
},
"api/despachante/veiculo/listar?cliente_id=?&quantidade_veiculos=?": {
"get": {
"tags": [
"Despachante/Veículos"
],
"summary": "Lista os veículos",
"description": "Lista os veículos pelo id do cliente informado. Caso necessite limitar a quantidade de veículos, deve-se passar o valor com a quantidade de veículos desejada através do campo quantidade_veiculos ",
"operationId": "veiculoListar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
},
{
"name": "cliente_id",
"in": "query",
"description": "Informa o id do cliente",
"required": true,
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
{
"name": "quantidade_veiculos",
"in": "query",
"description": "Informa a quantidade de veículos retornados",
"required": false,
"example": 99
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Veículos listados com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"veiculos": [
{
"id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"cliente_veiculo_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"placa": "AAA0000",
"modelo": "MODELO DO CARRO",
"estado_sigla": "SP",
"ultimo_pagamento": "2021",
"status": "Em dia | Atrasado | null",
"vencimento_licenciamento": "2019-12-31"
}
]
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/veiculo/consultar": {
"get": {
"tags": [
"Despachante/Veículos"
],
"summary": "Consulta o veículo",
"description": "Consulta o veículo pelo id do veículo informado",
"operationId": "veiculoConsultar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
},
{
"name": "veiculo_id",
"in": "path",
"description": "Informa o id do veículo",
"required": true,
"example": "api/despachante/veiculo/consultar/YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Dados do veículo retornado com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"veiculo": {
"id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"modelo": "MODELO DO CARRO",
"placa": "AAA0000",
"renavam": "111111111",
"cor": "",
"ano_fabricacao": "2001",
"combustivel": "",
"estado_sigla": "SP",
"estado_id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"ultimo_pagamento": "2019",
"status": "Em dia | Atrasado | null",
"vencimento_licenciamento": "2019-12-31"
}
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Não foi possível obter os dados do veículo"
}
}
}
},
"api/despachante/veiculo/remover": {
"delete": {
"tags": [
"Despachante/Veículos"
],
"summary": "Remove o veículo",
"description": "Remove o veículo pelo id do veículo e do cliente informado",
"operationId": "veiculoRemover",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"requestBody": {
"description": "Informa o id do veículo e do cliente",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"veiculo_id",
"cliente_id"
],
"properties": {
"veiculo_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"cliente_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Veículo removido com sucesso"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Veículo não encontrado"
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/veiculo/cadastrar": {
"post": {
"tags": [
"Despachante/Veículos"
],
"summary": "Cadastra um veículo ao cliente",
"description": "Cadastra um veículo para um determinado cliente",
"operationId": "veiculoCadastrar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"requestBody": {
"description": "Informa os dados do veículo e cliente",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"identificador",
"cliente_id"
],
"properties": {
"identificador": {
"type": "string",
"example": "AAA9999 | AAA9A99 | 999999999"
},
"cliente_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Veículo cadastrado com sucesso"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Não foi possível cadastrar o veículo"
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/veiculo/placa/cadastrar": {
"post": {
"tags": [
"Despachante/Veículos"
],
"summary": "Cadastra um veículo pela placa",
"description": "Cadastra um veículo informando a placa",
"operationId": "veiculoPlacaCadastrar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"requestBody": {
"description": "Informa a placa do veículo",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"identificador"
],
"properties": {
"identificador": {
"type": "string",
"example": "AAA9999 | AAA9A99"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Veículo adicionado com sucesso"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Você também pode tentar consultar seus débitos com o número do Renavam do seu veículo. / Você também pode tentar consultar seus débitos com a Placa do seu veículo."
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/veiculo/tipo/listar": {
"get": {
"tags": [
"Despachante/Veículos"
],
"summary": "Lista os tipos de veículos",
"description": "Lista os tipos de veículos",
"operationId": "veiculoTipoListar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Tipos de veículos listados com sucesso"
}
},
"type": "object"
},
"data": {
"type": "object",
"example": {
"tipo_veiculos": [
{
"id": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09",
"nome": "carro",
"descricao": "Carro"
}
]
}
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"422": {
"description": "Erro de validação"
}
}
}
},
"api/despachante/veiculo/estado/cadastrar": {
"post": {
"tags": [
"Despachante/Veículos"
],
"summary": "Cadastra um veículo de outro estado",
"description": "Cadastra um veículo de outro estado",
"operationId": "veiculoEstadoCadastrar",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {access-token}",
"required": true,
"schema": {
"type": "bearerAuth"
}
}
],
"requestBody": {
"description": "Informa a placa do veículo",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"renavam",
"email",
"estado_id"
],
"properties": {
"renavam": {
"type": "integer",
"example": 99999999999
},
"email": {
"type": "string",
"example": "email@email.com"
},
"estado_id": {
"type": "string",
"example": "YmxpZnV0RkhuOVVuakMxcWs2cXZ1Zz09"
},
"placa": {
"type": "string",
"example": "AAA9999 | AAA9A99"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Sucesso",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"properties": {
"message": {
"type": "string",
"example": "Veículo cadastrado com sucesso"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"500": {
"description": "Erro interno"
},
"401": {
"description": "Não autenticado"
},
"418": {
"description": "Falha ao salvar o veículo"
},
"422": {
"description": "Erro de validação"
}
}
}
}
},
"tags": [
{
"name": "Introdução",
"description": "Nessa documentação será descrito os endpoints da API"
},
{
"name": "Autenticação",
"description": "A autenticação é feita via token, que no qual é gerado pelo endpoint da API Checkout DOK: /api/auth/login
O token será incluido no header das requisições, no parâmetro Authorization, e deverá ficar de seguinte forma: Authorization : Bearer < token >"
}
]
}