# docs.machine.global

## Docs

- [Obter clientes](https://docs.machine.global/pages/v2/referencia/clientes/endpoint/get.md): Quando acionada, são retornados todos os clientes da central conforme os parâmetros informados.
- [Obter cliente por ID](https://docs.machine.global/pages/v2/referencia/clientes/endpoint/get-by-id.md): Retorna os detalhes de um cliente específico através do seu ID.
- [Desvincular área de permissão do condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/delete-areas-permissao.md): Desvincula um condutor de uma área de permissão.
- [Listar condutores](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/get.md): Retorna todos os condutores da central conforme os parâmetros informados. Para acessar este endpoint, o usuário autenticado deve ter a permissão `API - Corrida`.
- [Obter condutor por ID](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/get-by-id.md): Retorna um condutor da central conforme o ID informado. Para acessar este endpoint, o usuário autenticado deve ter a permissão `API - Corrida`.
- [Atualizar condutor parcialmente](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/patch-by-id.md): Atualiza parcialmente os dados do condutor. Envie apenas o ID e os campos que deseja alterar.
- [Vincular área de permissão ao condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-areas-permissao.md): Vincula um condutor a uma área de permissão.
- [Recarregar créditos do condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-creditos-recargas.md): Realiza uma recarga de créditos para um condutor identificado por tipo e valor de identificação.
- [Consultar saldo de créditos do condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-creditos-saldo-consultar.md): Consulta o saldo de créditos de um condutor identificado por tipo e valor de identificação.
- [Sacar créditos do condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-creditos-saques.md): Realiza um saque de créditos para um condutor identificado por tipo e valor de identificação.
- [Atualizar documento do condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-documentos-atualizar.md): Atualiza um documento específico do condutor com upload de arquivo.
- [Consultar documentos do condutor](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-documentos-consultar.md): Retorna os documentos cadastrados do condutor. O tipo de identificação pode ser CPF (C), viatura (V), telefone (T), placa do veículo (P) ou identificador do condutor (I).
- [Consultar requisitos de documentos para cadastro](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/post-requisitos-cadastro-documentos-consultar.md): Retorna os documentos necessários para o cadastro do condutor.
- [Atualizar áreas de bloqueio em lote](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/put-areas-bloqueio-batch.md): Atualiza em lote as áreas de bloqueio de um conjunto de condutores.
- [Atualizar condutor completo](https://docs.machine.global/pages/v2/referencia/condutores/endpoint/put-by-id.md): Atualiza completamente os dados do condutor. Todos os campos do corpo são obrigatórios, com exceção da regra entre `cpf` e `cnpj`: é obrigatório enviar pelo menos um dos dois.
- [Listar áreas geográficas](https://docs.machine.global/pages/v2/referencia/configuracoes/endpoint/areas-geograficas.md): Responsável por listar as áreas de bloqueio disponíveis para central.
- [Listar categorias](https://docs.machine.global/pages/v2/referencia/configuracoes/endpoint/categorias.md): Retorna as categorias ativas da central. Caso seja informada uma localização pertencente a uma filial, serão retornadas as categorias ativas da filial. Caso seja informada a latitude e longitude, não é necessário passar as demais informações.
- [Atualizar configurações](https://docs.machine.global/pages/v2/referencia/configuracoes/endpoint/patch.md): Permite alterar as configurações da sua central.
- [Atualizar categoria](https://docs.machine.global/pages/v2/referencia/configuracoes/endpoint/put-categorias.md): Permite atualizar os dados de uma categoria da central.
- [Ativar ou desativar saque automático](https://docs.machine.global/pages/v2/referencia/configuracoes/endpoint/saque-automatico-ativacao.md): Ativa ou desativa o saque automático da integração autenticada.
- [Listar tipos de documento](https://docs.machine.global/pages/v2/referencia/configuracoes/endpoint/tipos-documento.md): Responsável por retornar todos os documentos criados pela central.
- [Consultar corrida por ID](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-by-id.md): Consulta uma corrida específica pelo identificador interno da corrida.
- [Listar centros de custo da empresa](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-centros-custo.md): Lista centros de custo de uma empresa para uso no domínio de corridas.
- [Consultar detalhes da corrida](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-detalhes.md): Consulta o payload detalhado de uma corrida, incluindo progresso, motorista, empresa e paradas.
- [Listar funcionários da empresa](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-funcionarios.md): Lista funcionários por empresa ou por centro de custo.
- [Consultar posição do condutor na corrida](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-posicao-condutor.md): Retorna a posição do condutor em uma corrida.
- [Consultar corrida programada](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-programada-by-id.md): Consulta uma corrida programada específica.
- [Listar corridas programadas](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-programadas.md): Lista corridas programadas com paginação.
- [Consultar status da corrida](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/get-status.md): Consulta o status atual de uma corrida.
- [Cancelar corrida](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-cancelar.md): Cancela uma corrida existente pelo motivo informado.
- [Cancelar corrida programada](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-cancelar-programada.md): Cancela uma corrida programada.
- [Consultar corridas](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-consultar.md): Retorna as solicitações da central conforme os filtros informados. O intervalo máximo aceito entre `data_hora_solicitacao_min` e `data_hora_solicitacao_max` é de 30 dias. Para acessar este endpoint, o usuário precisa ter a permissão `API - Corrida`.
- [Criar corrida](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-criar.md): Cria uma corrida avulsa, aceitando dados de cadastro, passageiro, origem, destino, empresa, filtros extras e paradas.
- [Criar corrida programada](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-criar-programada.md): Cria uma corrida programada utilizando o payload de criação de corrida mais os campos de agendamento.
- [Estimar corrida para empresa](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-empresa-estimativas.md): Calcula estimativa de corrida no contexto da empresa informada na URL.
- [Estimar corrida](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-estimativas.md): Calcula estimativa de corrida simples ou multicategorias a partir de coordenadas ou endereço. Quando `multicategorias` é `true`, a API calcula a estimativa de múltiplas categorias.
- [Estimar corrida programada](https://docs.machine.global/pages/v2/referencia/corridas/endpoint/post-programada-estimativas.md): Calcula estimativa de corrida programada a partir de data, hora e dados de origem e destino.
- [Listar geradores de cupom](https://docs.machine.global/pages/v2/referencia/cupons/endpoint/get-geradores.md): Retorna a lista de geradores de cupom disponíveis para a bandeira autenticada. Os geradores são necessários para criar novos cupons via `POST /cupons`.
- [Criar cupom](https://docs.machine.global/pages/v2/referencia/cupons/endpoint/post.md): Cria um novo cupom de desconto vinculado a um gerador de cupom.
- [Obter dinâmicas por área](https://docs.machine.global/pages/v2/referencia/dinamicas/endpoint/get-area.md): Lista as dinâmicas associadas às áreas.
- [Obter dinâmica sem área](https://docs.machine.global/pages/v2/referencia/dinamicas/endpoint/get-sem-area.md): Obtém a dinâmica sem área.
- [Ativar/Desativar dinâmica por área](https://docs.machine.global/pages/v2/referencia/dinamicas/endpoint/patch-area.md): Ativa ou desativa a dinâmica associada a uma área específica.
- [Ativar/Desativar dinâmica sem área](https://docs.machine.global/pages/v2/referencia/dinamicas/endpoint/patch-sem-area.md): Ativa ou desativa a dinâmica sem área.
- [Listar empresas](https://docs.machine.global/pages/v2/referencia/empresas/endpoint/get.md): Retorna todas as empresas conveniadas à central. O campo "dados_extras" somente é retornado com autenticação de Central. Caso uma quebra de linha ocorra, serão retornados os caracteres "\r\n" indicando a quebra de linha.
- [Obter empresa](https://docs.machine.global/pages/v2/referencia/empresas/endpoint/get-by-id.md): Retorna dados de uma empresa específica.
- [Cadastrar empresa](https://docs.machine.global/pages/v2/referencia/empresas/endpoint/post.md): Este endpoint permite o cadastro de empresas.
- [Atualizar empresa](https://docs.machine.global/pages/v2/referencia/empresas/endpoint/put.md): Esse endpoint permite a atualização de dados da empresa (status ou número de contrato), sendo necessário informar o id da empresa que se deseja atualizar.
- [Atualizar empresas (batch)](https://docs.machine.global/pages/v2/referencia/empresas/endpoint/put-batch.md): Esse endpoint permite atualizar as empresas em lote.
- [Deletar webhook de engajamento](https://docs.machine.global/pages/v2/referencia/engajamento/endpoint/delete.md): Deleta um webhook de engajamento a partir de seu ID. Regras importantes: - Envio de eventos do webhook removido para em até 5 minutos após deleção.
- [Listar webhooks de engajamento](https://docs.machine.global/pages/v2/referencia/engajamento/endpoint/get.md): Lista webhooks de engajamento cadastrados e bandeiras sem webhook vinculado. Regras importantes: 1. Bandeiras apenas do mesmo grupo; 2. Apenas Bandeiras ativas são retornadas na lista de bandeiras sem webhook vinculado.
- [Criar webhook de engajamento](https://docs.machine.global/pages/v2/referencia/engajamento/endpoint/post.md): Cria um webhook de engajamento a partir de uma URL. Regras importantes: - Os Headers são opcionais e limitados a 10 chaves; - Não é possível criar 2 webhooks com a mesma URL.
- [Editar webhook de engajamento](https://docs.machine.global/pages/v2/referencia/engajamento/endpoint/put.md): Editar um webhook de engajamento a partir de seu ID. Regras importantes: - Os Headers são limitados a 10 chaves; - Pode-se editar a URL ou Headers; - Não é possível editar um webhook com mesma URL de outro já existente; - Envio de eventos do webhook é alterado em até 5 minutos após edição.
- [Remover bandeiras de webhook](https://docs.machine.global/pages/v2/referencia/engajamento/permissoes/endpoint/delete.md): Remove vinculo de um grupo de bandeiras do webhook. Regras importantes: - Recebe um array bandeiras com cada bandeira_id a ser removido; - Envio de eventos do webhook é alterado em até 5 minutos após a deleção.
- [Adicionar bandeiras e permissões a webhook](https://docs.machine.global/pages/v2/referencia/engajamento/permissoes/endpoint/post.md): Adiciona/Substitui o grupo de bandeiras atual de um webhook e define as permissões dessas bandeiras. **Remove bandeiras anteriores e permissões anteriores do webhook.** Regras importantes: - Recebe um array de bandeiras com cada bandeira_id e eventos que a bandeira deve receber; - Impede inclusão de…
- [Adicionar/Editar permissões de uma bandeira](https://docs.machine.global/pages/v2/referencia/engajamento/permissoes/endpoint/put.md): Adiciona bandeira à um webhook e define as permissões dessa bandeira. Regras importantes: - Recebe um objeto bandeira com cada bandeira_id e eventos que a bandeira deve receber; - Impede inclusão de bandeiras já atreladas a outros webhooks; - Envio de eventos do webhook é alterado em até 5 minutos a…
- [Listar áreas de atuação](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-areas-atuacao.md): Esse endpoint retorna as áreas de atuação da bandeira. Serão retornados os seguintes dados de cada área: - `id` - Identificador da área - `nome`- Nome da área - `padrao` - Indica se a área é a padrão da central
- [Consultar entrega](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-by-id.md): Ao acionar, retorna uma entrega da central especificada pelo id da solicitação
- [Obter posição do entregador](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-condutor-posicao.md): Retorna a latitude e longitude do condutor de uma entrega naquele instante. Caso a entrega ainda estiver na fase de despacho (status distribuindo, pendente ou aguardando aceite) ou já estiver sido finalizada/cancelada (status não atendida, cancelada ou finalizada), o retorno será latitude e longitud…
- [Obter detalhes da entrega](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-detalhes.md): Obter detalhes da entrega
- [Obter links de rastreio](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-links-rastreio.md): Permite obter os links de rastreio para todos os pedidos de uma solicitação de entrega. Também gera o código de confirmação do pedido quando a configuração da central "Solicitar código de confirmação de entrega dos pedidos" estiver ativa.
- [Listar entregas programadas](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-programadas.md): Permite listar todas as entregas programadas de uma central.
- [Listar entrega programada por id](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-programadas-by-id.md): Permite obter uma única entrega programada através de seu id.
- [Obter recibo](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-recibo.md): Retorna as informações necessárias para a construção do recibo da solicitação de entrega. A entrega deve pertencer a bandeira e ter seu status como finalizada (F).
- [Obter status](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/get-status.md): Permite obter o status de uma solicitação de entrega pelo seu Id. Os possíveis retornos de status são: D - Distribuindo, G - Aguardando aceite, A - Aceita, S - Em espera, E - Em andamento, F - Finalizada, N - Não atendida, C - Cancelada, P - Pendente.
- [Abrir entrega](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post.md): Ao acionar, abre uma nova solicitação de entrega padrão.
- [Cancelar entrega](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-cancelar.md): Cancela a solicitação de entrega, modificando seu status para `C`. A solicitação não pode ter sido finalizada, cancelada ou não atendida anteriormente.
- [Consultar entregas](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-consultar.md): Ao acionar, são retornadas todas as entregas da central conforme os parâmetros informados.
- [Estimar entrega por empresa](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-empresas-estimativas.md): Permite obter a estimativa do valor da entrega por empresa em uma única categoria
- [Estimar entrega](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-estimativas.md): Permite obter a estimativa do valor da entrega em uma única categoria
- [Criar entrega programada](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-programadas.md): Permite criar uma solicitação de entrega programada.
- [Cancelar entrega programada](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-programadas-cancelar.md): Cancela (mudando para status C), a solicitação programada informada. A solicitação não pode estar com o status aguardando (A).
- [Estimar entrega programada](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-programadas-estimativas.md): Permite obter a estimativa do valor da entrega programada em uma única categoria
- [Recarregar créditos da empresa](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-recargas.md): As empresas podem possuir carteiras de crédito, com isso, esse endpoint permite adicionar créditos para a empresa em questão. O tipo de identificação, é uma forma de identificação da empresa, desta forma de acordo com o tipo de identificação, o valor da identificação da empresa irá respeitar a regra…
- [Obter saldo da empresa](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-saldo.md): As empresas podem possuir carteiras de crédito, com isso, esse endpoint permite verificar o saldo em créditos para a empresa em questão. O tipo de identificação, é uma forma de identificação da empresa, desta forma de acordo com o tipo de identificação, o valor da identificação da empresa irá respei…
- [Sacar créditos da empresa](https://docs.machine.global/pages/v2/referencia/entregas/endpoint/post-saques.md): As empresas podem possuir carteiras de crédito, com isso, esse endpoint permite sacar créditos para a empresa em questão. O tipo de identificação, é uma forma de identificação da empresa, desta forma de acordo com o tipo de identificação, o valor da identificação da empresa irá respeitar a regra do…
- [Introdução](https://docs.machine.global/pages/v2/referencia/introducao.md): Base URL, autenticação, códigos de status e limites da API.
- [Enviar mensagem no chat central de condutor](https://docs.machine.global/pages/v2/referencia/mensagens/endpoint/post-condutor-broadcast.md): Envia uma mensagem no chat central dos condutores da bandeira.
- [Enviar mensagem privada para condutor](https://docs.machine.global/pages/v2/referencia/mensagens/endpoint/post-condutor-privada.md): Envia uma mensagem privada para um condutor específico. Para a mensagem ser corretamente enviada, é necessário que o condutor tenha o status de ativo.
- [Enviar mensagem no chat central de empresa](https://docs.machine.global/pages/v2/referencia/mensagens/endpoint/post-empresa-broadcast.md): Envia uma mensagem no chat central de empresas da bandeira. A mensagem será visível no chat geral de empresas no painel da central.
- [Enviar mensagem privada para empresa](https://docs.machine.global/pages/v2/referencia/mensagens/endpoint/post-empresa-privada.md): Envia uma mensagem privada para uma empresa específica. A empresa deve estar ativa (`status = 'A'`) na bandeira e possuir um usuário com permissão de receber mensagens.
- [Enviar notificação in-app](https://docs.machine.global/pages/v2/referencia/notificacao/endpoint/post-in-app-messaging.md): Envia notificação via in-app messaging para uma lista de passageiros.
- [Enviar notificação push](https://docs.machine.global/pages/v2/referencia/notificacao/endpoint/post-push.md): Envia notificação push para uma lista de passageiros.
- [Deletar webhook](https://docs.machine.global/pages/v2/referencia/webhooks/endpoint/delete.md): Permite deletar um webhook.
- [Listar webhooks](https://docs.machine.global/pages/v2/referencia/webhooks/endpoint/get.md): Permite visualizar os webhooks cadastrados.
- [Cadastrar webhook](https://docs.machine.global/pages/v2/referencia/webhooks/endpoint/post.md): Permite cadastrar um webhook.
- [Atualizar webhook](https://docs.machine.global/pages/v2/referencia/webhooks/endpoint/put.md): Permite atualizar a url de um webhook. É possível uma central atualizar o webhook de uma empresa cadastrada em sua operação.
- [Bem-vindo](https://docs.machine.global/pages/v2/welcome.md)

## OpenAPI Specs

- [openapi](https://docs.machine.global/api-reference/openapi.json)
- [openapi-entregas](https://docs.machine.global/pages/v1/openapi-entregas.json)