Skip to main content

API de Integração v2

Integre seu sistema com a plataforma Machine de maneira simples, segura e eficaz. Este guia contém tudo o que você precisa para começar sua jornada conosco.

Quem Somos

A Machine é um produto Gaudium, projetado para fornecer tecnologia que permite a operação eficiente e segura das centrais de mobilidade urbana e entregas. Fornecemos as ferramentas para que condutores realizem serviços com excelência.

Evolução Constante

Nossa plataforma está em constante evolução. Recomendamos acompanhar nossos informes e o changelog para se manter atualizado sobre as novas funcionalidades e melhorias na integração.

HATEOAS na v2

HATEOAS é um padrão em que o próprio retorno da API guia você pelos endpoints relacionados ao recurso consultado. Com esses links, seu sistema consegue identificar quais próximas ações estão disponíveis sem consultar a documentação a cada etapa do fluxo. Na v2, esses links ficam no objeto __links.

Estrutura do objeto __links

Cada chave dentro de __links representa uma ação disponível. O valor da chave informa o endpoint e o método HTTP que devem ser usados para executar essa ação.
  • __links: objeto que agrupa os links HATEOAS retornados pela API.
  • self: link para consultar o próprio recurso retornado na resposta.
  • href: caminho do endpoint que deve ser chamado.
  • metodo: método HTTP aceito pelo endpoint, como get, post ou patch.
  • Demais chaves, como atualizar-dinamica-area: ações relacionadas ao recurso atual.

Como usar

Primeiro chame um endpoint que retorna HATEOAS. Depois escolha uma ação em __links e faça a próxima requisição usando o href e o metodo da resposta.

Endpoints com HATEOAS

RecursoEndpoints
CorridasPOST /api/v2/integracao/corridas/consultar
POST /api/v2/integracao/corridas/
Corridas programadasGET /api/v2/integracao/corridas/programadas
POST /api/v2/integracao/corridas/programadas
EntregasPOST /api/v2/integracao/entregas/consultar
POST /api/v2/integracao/entregas
Entregas programadasGET /api/v2/integracao/entregas/programadas
POST /api/v2/integracao/entregas/programadas
Créditos da empresa em entregasGET /api/v2/integracao/entregas/empresas/creditos/saldo
POST /api/v2/integracao/entregas/empresas/creditos/recargas
POST /api/v2/integracao/entregas/empresas/creditos/saques
ClientesGET /api/v2/integracao/clientes
CondutoresGET /api/v2/integracao/condutores
Créditos de condutoresPOST /api/v2/integracao/condutores/creditos/saldo/consultar
POST /api/v2/integracao/condutores/creditos/recargas
POST /api/v2/integracao/condutores/creditos/saques
EmpresasGET /api/v2/integracao/empresas
POST /api/v2/integracao/empresas
DinâmicasGET /api/v2/integracao/dinamicas/area
GET /api/v2/integracao/dinamicas/sem-area
MensagensPOST /api/v2/integracao/mensagens/condutor/broadcast
POST /api/v2/integracao/mensagens/condutor/{id}
POST /api/v2/integracao/mensagens/empresa/broadcast
POST /api/v2/integracao/mensagens/empresa/{id}

Primeiros passos

Explore a tab “Referência” para obter mais informações sobre como se conectar à API e testar os endpoints.

Pronto! Agora você está preparado para explorar a nossa integração para que, juntos, possamos crescer ainda mais.