API para developers

Construa com o RouteMate

Ligue a sua plataforma através da nossa REST API. Importe paragens do seu e-commerce, execute a otimização de rotas e acompanhe entregas por API.

API do RouteMate

POST /v1/integration-import

Pedido

{
  "external_job_id": "BATCH-001",
  "title": "Morning Deliveries",
  "driver_email": "driver@example.com",
  "stops": [
    {
      "external_stop_id": "STOP-1",
      "address": "1 George St, Brisbane QLD 4000",
      "label": "Customer A",
      "parcel_count": 2
    }
  ]
}

Resposta

{
  "job_id": "e7ad097b-...",
  "optimization": {
    "total_distance_km": 12.4,
    "total_duration_minutes": 25
  },
  "stops": [ /* optimized order */ ],
  "warnings": [...]
}

Obter credenciais

Gere o seu client ID e secret na página de definições do dashboard RouteMate.

Pedir token

Troque as credenciais por um bearer token válido durante uma hora.

Chamar a API

Inclua o token no cabeçalho Authorization para pedidos de importação e estado.

Autenticação

Fluxo de client credentials

A API do RouteMate utiliza um fluxo OAuth2 client credentials. Troque o client ID e o secret por um bearer token temporário e inclua-o no cabeçalho Authorization.

Obter credenciais

Gere o seu client ID e secret na página de definições do dashboard RouteMate.

Pedir token

Troque as credenciais por um bearer token válido durante uma hora.

Chamar a API

Inclua o token no cabeçalho Authorization para pedidos de importação e estado.

API

Endpoints principais da API

Estes endpoints cobrem as tarefas de integração mais comuns nos fluxos de entrega.

POST/v1/integration-token

Obter um access token

Troque as suas client credentials por um access token temporário válido durante uma hora.

Pedido

{
  "client_id": "rm_ci_your_client_id",
  "client_secret": "rm_cs_your_client_secret"
}

Resposta

{
  "access_token": "rm_at_e5988dd1b91a...",
  "token_type": "Bearer",
  "expires_in": 3600
}

POST/v1/integration-import

Importar um job e otimizar a rota

Envie um job com paragens, geocodifique moradas, otimize a ordem da rota e atribua o trabalho ao motorista.

Pedido

{
  "external_job_id": "BATCH-001",
  "title": "Morning Deliveries",
  "driver_email": "driver@example.com",
  "stops": [
    {
      "external_stop_id": "STOP-1",
      "address": "1 George St, Brisbane QLD 4000",
      "label": "Customer A",
      "parcel_count": 2
    }
  ]
}

Resposta

{
  "job_id": "e7ad097b-...",
  "optimization": {
    "total_distance_km": 12.4,
    "total_duration_minutes": 25
  },
  "stops": [ /* optimized order */ ],
  "warnings": [...]
}

GET/v1/integration-jobs

Consultar o estado do job

Verifique o estado do job, o progresso das paragens e os resultados da entrega a qualquer momento.

Pedido

// GET request

Resposta

{
  "job_id": "e7ad097b-...",
  "status": "assigned",
  "stop_count": 3,
  "status_counts": {
    "pending": 2,
    "completed": 1
  },
  "stops": [...]
}

Exemplos de código

Comece em minutos

Use os exemplos abaixo para autenticar, importar jobs e verificar o estado das entregas.

curl

curl -X POST https://api.routemate.app/v1/integration-token \
  -H "Content-Type: application/json" \
  -d '{"client_id":"rm_ci_your_client_id","client_secret":"rm_cs_your_client_secret"}'

node

const tokenRes = await fetch("https://api.routemate.app/v1/integration-token", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    client_id: "rm_ci_your_client_id",
    client_secret: "rm_cs_your_client_secret",
  }),
});

python

import requests

token_res = requests.post(
    "https://api.routemate.app/v1/integration-token",
    json={
        "client_id": "rm_ci_your_client_id",
        "client_secret": "rm_cs_your_client_secret",
    },
)

Criado para equipas SaaS

Pronto para produção desde o primeiro dia

Desenhado para fluxos de entrega fiáveis, novas tentativas e operações a jusante.

Autenticação segura

Bearer tokens temporários e troca controlada de credenciais.

Importações rápidas

Envie entregas do seu sistema num único pedido.

Retentativas fiáveis

Use chaves de idempotência para repetir pedidos falhados em segurança.

Visibilidade de estado

Acompanhe jobs e progresso das paragens por API.

Precisa de uma integração personalizada?

Fale connosco sobre workflows de parceiros, onboarding personalizado e acesso enterprise à API.