Vuxx API (alpha)

Download OpenAPI specification:Download

Vuxx Product Team: produto@vuxx.com.br

Vuxx API

Authentication

Endpoints related to authenticated user.

Login (inicia sessão)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"email": "ops@gadle.it",
"password": "123"
}

Response samples

200

Content type

application/json

{"expiry": "2022-12-27T04:44:21-03:00",
"identifier": "k9l4e58o",
"token": "5acfed2619a9a9def85742f036244bca265e74613f4d4a7427ee7a992ceb4e5f"
}

Identificação da sessão atual

Authorizations:

SessionTokenApiToken

Logout (encerra sessão)

Authorizations:

SessionTokenApiToken

Identificação do usuário logado (motorista)

Ver GadleAPI\Auth\SymfonySecurity\DriverUser

Authorizations:

SessionTokenApiToken

Identificação do JWT

Authorizations:

SessionTokenApiToken

Identificação do usuário logado (API)

Ver AuthIntrospectionController

Authorizations:

SessionTokenApiToken

Informações do usuário logado

Authorizations:

SessionTokenApiToken

Login do motorista (v1)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"username": "usuario@example.com",
"password": "1234",
"deviceId": "77a7b4e0-9d9a-40e3-b32c-e6d3391ac820",
"appVersionName": "2.28.0",
"appVersionCode": 295
}

Response samples

200

Content type

application/json

{"sessionToken": "0eOaK6GjdCrG/4xBsQjQ/iOe9VRgZdbH",
"driverId": 11325,
"name": "Paula Oliveira",
"phone": "19981730015",
"intercomMetadata": { }
}

Logout do motorista (v1)

Authorizations:

BrainSessionToken

Gera token do motorista (v2)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"username": "usuario@example.com",
"password": "1234"
}

Response samples

200

Content type

application/json

{"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhYWI0MWlwbyIsImRyaXZlcklkIjoxMTMyOCwiaWF0IjoxNTE2MjM5MDIyfQ.s6kGqS1p2ge870dxBgYTJU2oWoIxMdbqJ_elPF4vjew",
"userDetails": {"id": 11328,
"email": "claudia23@gmail.com",
"name": "Claudia Ramalho",
"firstName": "Claudia",
"lastName": "Ramalho"
}
}

Gera token do motorista (v2) a partir da sessão v1

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"sessionToken": "6RDbLm3zJF/mg6vW7aMz68yH3nS5iHdL"
}

Response samples

200

Content type

application/json

{"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhYWI0MWlwbyIsImRyaXZlcklkIjoxMTMyOCwiaWF0IjoxNTE2MjM5MDIyfQ.s6kGqS1p2ge870dxBgYTJU2oWoIxMdbqJ_elPF4vjew",
"userDetails": {"id": 11328,
"email": "claudia23@gmail.com",
"name": "Claudia Ramalho",
"firstName": "Claudia",
"lastName": "Ramalho"
}
}

Customer

Cadastro e gestão de clientes.

Lista de flags reconhecidas

cliente

Authorizations:

SessionTokenApiToken

Responses

Response samples

200

Content type

application/json

{"categories": ["Solicitação",
"Precificação"
],
"settings": [{"category": "Solicitação",
"id": "feature:vehicle_types.passeio",
"name": "Veículos habilitados: Carro de passeio",
"type": "boolean"
},
{"category": "Precificação",
"id": "feature:pricing.use_declared_distance",
"name": "Precificação pela distância declarada",
"type": "boolean"
}
]
}

Ver configurações (flags) do cliente

Devolve todas as configurações que foram definidas para o cliente.

Configurações que não foram definidas explicitamente para o cliente não serão exibidas. Nesse caso, assume-se que a aplicação usará o valor padrão definido internamente.

Authorizations:

SessionTokenApiToken

path Parameters

customerId

required

string (schemas-CustomerId)

Responses

Response samples

200

Content type

application/json

{"feature:vehicle_types.bitruck": true,
"feature.pricing.use_declared_distance": false
}

Alterar configurações do cliente

Altera as configurações que forem dadas no corpo da requisição. Configurações que não forem mencionadas serão mantidas intactas.

Authorizations:

SessionTokenApiToken

path Parameters

customerId

required

string (schemas-CustomerId)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"feature:vehicle_types.passeio": true
}

Alterar configurações do cliente (PUT)

Altera todas as configurações tratadas por esse endpoint.

Atualmente só trata as regras de alocação de motoristas.

Authorizations:

SessionTokenApiToken

path Parameters

customerId

required

string (schemas-CustomerId)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"driverAllocationRules": [{"name": "hasTag",
"value": "treinamento:direcao_defensiva"
},
{"name": "notHasTag",
"value": "veiculo:refrigerado"
}
]
}

Jotform

Receive Jotform submissions

Register an incoming submission from a Jotform form.

Authorizations:

WebhookFixedToken

Request Body schema: multipart/form-data

formID	string Identificador (numérico) do formulário.
formTitle	string Título do formulário, conforme visível na página "Meus formulários".
webhookURL	string URL do webhook que está sendo chamado, conforme cadastrado na configuração de integrações do formulário.
type	string
username	string
submissionID	string Identificador (numérico) desta resposta.
ip	string Endereço IP a partir de onde esta submissão do formulário foi enviada.
pretty	string Concatenação de todos os nomes e valores de campos.
	object Detalhes da resposta, codificados em uma string JSON.

Responses

Users

Alterar usuário

Altera informações de um usuário.

Para usuários que têm conta no Admin e no TMS/API, a alteração de senha afeta ambos os sistemas.

Authorizations:

SessionTokenApiToken

path Parameters

required

string or integer (UserNameOrId)

Request Body schema: application/json

object

Todos os campos são opcionais. Apenas os campos que forem informados serão atualizados.

Request samples

Payload

Content type

application/json

{"name": "Liliane dos Reis Salomão",
"password": "999999",
"roleId": 0,
"customerId": 3212,
"emailReports": {"spotStatusUpdate": true,
"podFailure": true,
"podSuccess": false
}
}

Lista usuários do cliente

Authorizations:

SessionTokenApiToken

path Parameters

customerId

required

integer (CustomerId)

Cria usuário no cliente

Authorizations:

SessionTokenApiToken

path Parameters

customerId

required

integer (CustomerId)

Alterar usuário do Admin

Authorizations:

SessionTokenApiToken

path Parameters

required

string or integer (UserNameOrId)

Order

Retrieves the transportations contained in an order.

Authorizations:

SessionTokenApiToken

path Parameters

orderId

required

string (Order ID) \d+

Example: 86721

Order ID.

Responses

Response samples

200
401
404

Content type

application/json

{"orderId": "12345",
"places": {"customer-warehouse": {"label": "#stopId-3212",
"address": {"postalCode": "04531939",
"thoroughfare": "Rua Professor Carlos de Carvalho",
"number": "164",
"neighborhood": "Itaim Bibi",
"locality": "São Paulo",
"state": "SP"
},
"geolocation": {"latitude": -23.582794,
"longitude": -46.680237
},
"instructions": "Falar com Severino",
"timeWindow": {"start": "8:00",
"end": "17:00"
}
},
"new-place-a": {"label": "new-place-a",
"address": {"postalCode": "04547130",
"thoroughfare": "Alameda Vicente Pinzon",
"number": "54",
"neighborhood": "Vila Olímpia",
"locality": "São Paulo",
"state": "SP"
},
"geolocation": {"latitude": -23.595517,
"longitude": -46.686966
},
"instructions": "Entrada pela Rua Gomes de Carvalho",
"timeWindow": {"start": "8:00",
"end": "17:00"
},
"addressee": {"name": "Felipe Trevisan",
"phoneNumber": "+551131675138",
"nationalDocumentNumber": "23372813000108"
}
}
},
"transportations": [{"id": "331255",
"label": "A",
"origin": "#stopId-3212",
"destination": "#new-place-a",
"shipments": [{"id": "412789",
"code": "BL125098",
"accessKey": "35210445990181000189550200005489721303345280"
}
]
}
]
}

Adds, removes and/or updates transportations contained in an order.

Authorizations:

SessionTokenApiToken

path Parameters

orderId

required

string (Order ID) \d+

Example: 86721

Order ID.

Request Body schema: application/json

	Array of objects (NewTransportation) Transportations that should be created and added to this order.
	Array of objects
	Array of objects
	object (Places) A collection of places, keyed by the place's label.

Responses

Request samples

Payload

Content type

application/json

{"transportations:add": [{"origin": "#stopId-3212",
"destination": "#new-place-a",
"shipments": [{"code": "BL125098",
"accessKey": "35210445990181000189550200005489721303345280"
}
]
}
],
"transportations:remove": [{"id": "4478211"
}
],
"transportations:update": [{"transportationId": "4478211",
"shipments:add": [{"code": "BL125098",
"accessKey": "35210445990181000189550200005489721303345280"
}
],
"shipments:remove": [{"id": "2873298"
}
]
}
],
"places:add": {"new-place-a": {"label": "new-place-a",
"address": {"postalCode": "04547130",
"thoroughfare": "Alameda Vicente Pinzon",
"number": "54",
"neighborhood": "Vila Olímpia",
"locality": "São Paulo",
"state": "SP"
},
"geolocation": {"latitude": -23.595517,
"longitude": -46.686966
},
"addressee": {"name": "Felipe Trevisan",
"phoneNumber": "+551131675138",
"nationalDocumentNumber": "23372813000108"
}
}
}
}

Response samples

401
404
422

Content type

application/json

{"detail": "Unauthorized"
}

Geocoding

Get the complete address and geolocation for a postal code + number pair.

Authorizations:

SessionTokenApiToken

path Parameters

postalCode required	string (Postal code (Brazil)) ^\d{8}$ Example: 04531939
number required	string or null Example: 164 Can be empty.

Responses

Response samples

200
404

Content type

application/json

Example

with-geolocation

{"address": {"postalCode": "04531939",
"thoroughfare": "Rua Professor Carlos de Carvalho",
"number": "164",
"neighborhood": "Itaim Bibi",
"locality": "São Paulo",
"state": "SP"
},
"geolocation": {"latitude": -23.582794,
"longitude": -46.680237
}
}

Carteira do Motorista

Carteira do motorista: consultas e operações relacionadas aos pagamentos a motoristas.

Listagem de carteiras

Usuário: FinOps 💰

Authorizations:

SessionTokenApiToken

Responses

Consulta lançamentos pendentes (global)

Usuário: FinOps 💰

Ainda não implementado

Authorizations:

SessionTokenApiToken

Responses

Consulta saques pendentes (global)

Usuário: FinOps 💰

Authorizations:

SessionTokenApiToken

Responses

Consulta saldo da carteira

Usuário: Driver 🚗

Authorizations:

SessionTokenApiToken

Responses

Inicia processo de saque

Devolve saldo, taxas, conta; pode até devolver um ID da transação

Usuário: Driver 🚗

Pode ser GET se não criar/alterar nenhum estado

Authorizations:

SessionTokenApiToken

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Solicita saque da carteira

Usuário: Driver 🚗

Authorizations:

SessionTokenApiToken

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Consulta saldo da carteira (Admin)

Usuário: FinOps 💰

Authorizations:

SessionTokenApiToken

path Parameters

driverId

required

string (DriverId)

Responses

Lança crédito/débito manual

Usuário: FinOps 💰

Registrar valores que foram movimentados por fora do sistema. Por exemplo, valores pagos normalmente (sem ser pelo Transfeera).

Este endpoint desconsidera algumas restrições normais como impedimento de saldos negativos. Se efetivamente foi transferido um valor a mais do que o saldo permitiria, o sistema permite o registro, mas deixa sinalizado que o saldo ficou negativo.

TODO:

A princípio não precisaria considerar adiantamentos. Mas, como um endpoint de inserção manual, seria possível aceitar dois campos separados: valor sacado (debitado do saldo) e valor efetivamente recebido pelo motorista.

Authorizations:

SessionTokenApiToken

path Parameters

driverId

required

string (DriverId)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Libera lançamento na carteira

Usuário: FinOps 💰

Authorizations:

SessionTokenApiToken

path Parameters

driverId required	string (DriverId)
orderId required	integer (schemas-OrderId)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Libera saque da carteira

Usuário: FinOps 💰

Authorizations:

SessionTokenApiToken

path Parameters

driverId required	string (DriverId)
saqueId required	string (SaqueId)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Recusa saque da carteira

Usuário: FinOps 💰

Recusa o saque pendente e estorna o valor para carteira.

Authorizations:

SessionTokenApiToken

path Parameters

driverId required	string (DriverId)
saqueId required	string (SaqueId)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Webhook - Transfeera

Atualizações de transações no gateway de pagamentos Transfeera.

https://docs.transfeera.dev/pagamentos/webhook

Atualiza transação de pagamento

Webhook contendo atualização de informações de uma transação de pagamento

https://docs.transfeera.dev/pagamentos/webhook

Authorizations:

WebhookFixedToken

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Atualiza devolução de transação de pagamento

Webhook contendo atualização de informações sobre uma devolução de transação de pagamento

https://docs.transfeera.dev/pagamentos/webhook

Authorizations:

WebhookFixedToken

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Receiver Payments

Pagamentos realizados pelo destinatário das entregas.

Usado na integração com o Pix da Ambev (ver pasta no Google Drive).

Lista os pagamentos da parada

Lista todas as notas fiscais da parada que estão pagas ou pendentes de pagamento.

Authorizations:

SessionTokenApiToken

path Parameters

orderId required	integer
stopId required	integer

Responses

Response samples

200

Content type

application/json

[{"id": "420ef5fa-07bf-4764-b3af-95f9aca64479",
"createdAt": "2019-08-24T14:15:22Z",
"shipmentId": 0,
"transportationId": 0,
"stopId": 0,
"orderId": 0,
"customerId": 0,
"totalValue": "314.27",
"availablePaymentTypes": ["PIX"
],
"nfAccessKey": "35210445990181000189550200005489721303345280",
"metadata": { },
"paid": true
}
]

Cria Pix para pagamento do destinatário

Cria uma ordem de pagamento via Pix para que o destinatário da entrega faça um pagamento. O QR Code deverá ser exibido no aplicativo do motorista para que o destinatário escaneie.

A ordem de pagamento se refere a uma entrega específica, e o destinatário pode escolher agrupar os pagamentos que ele irá realizar.

Authorizations:

SessionTokenApiToken

path Parameters

orderId required	integer
stopId required	integer

Request Body schema: application/json

receiverPaymentIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"receiverPaymentIds": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "05049530-12b6-44f8-91bb-63ebc7def549",
"qrCode": {"decodedContent": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"mimeType": "image/png",
"imageContent": "cG5nIGltYWdlCg=="
},
"currentStatus": "WAITING_FOR_PAYMENT",
"totalValue": "980.03",
"receiverPayments": [{"id": "420ef5fa-07bf-4764-b3af-95f9aca64479",
"createdAt": "2019-08-24T14:15:22Z",
"shipmentId": 0,
"transportationId": 0,
"stopId": 0,
"orderId": 0,
"customerId": 0,
"totalValue": "314.27",
"availablePaymentTypes": ["PIX"
],
"nfAccessKey": "35210445990181000189550200005489721303345280",
"metadata": { },
"paid": true
}
]
}

Verifica status do pagamento Pix

Verifica status de um pagamento Pix já solicitado.

Authorizations:

SessionTokenApiToken

path Parameters

orderId required	integer
stopId required	integer
pixId required	string Example: 05049530-12b6-44f8-91bb-63ebc7def549

Responses

Response samples

200

Content type

application/json

{"status": "WAITING_FOR_PAYMENT"
}