Pāriet uz saturu

Izstrādātājiem

API un tīmekļa āķi

Jūsu interneta veikals vai cita sistēma sūta pasūtījumus uz Routehive kā pieturas un saņem piegādes statusu caur tīmekļa āķi vai vaicājumu. Pieejams paketēs Pro un Fleet.

Mašīnlasāms apraksts (OpenAPI)

Autentifikācija

API atslēgu izveido īpašnieks vai administrators lietotnes lapā API un tīmekļa āķi. Atslēga tiek parādīta tikai vienreiz. Sūtiet to katra pieprasījuma galvenē kā Bearer marķieri. Ar tikai lasīšanas atslēgu pieturas pievienot nevar.

curl -X POST https://routehive.eu/api/v1/stops \
  -H "Authorization: Bearer rh_..." \
  -H "Content-Type: application/json" \
  -d '{
    "address": "Budapest, Andrássy út 1.",
    "name": "Example Ltd.",
    "phone": "+36 30 123 4567",
    "reference": "WS-1001",
    "cod_amount": 12500,
    "packages": ["PKG-1001"]
  }'

Galapunkti

GET /api/v1/routes?date=YYYY-MM-DD
Vienas dienas maršruti (pēc noklusējuma šodien, uzņēmuma laika joslā).
GET /api/v1/routes/{id}
Maršruts ar pieturām secībā.
POST /api/v1/stops
Jauna pietura, piemēram, interneta veikala pasūtījums.
GET /api/v1/stops/{id}
Pieturas statuss: piegādāts, neizdevās, iekasētā summa, foto un paraksts.

Pieturas pievienošana

Bez maršruta pietura nonāk dienas maršrutā Ienākošie, no kurienes to sadala dispečers. Ja to pašu pasūtījuma numuru (reference) tai pašai dienai nosūtāt vēlreiz, jauna pietura netiek izveidota: saņemat esošo. Atkārtota sūtīšana ir droša.

Lauki

address
Adrese (obligāti). Ar koordinātām adreses meklēšana tiek izlaista.
name
Saņēmēja vai uzņēmuma nosaukums.
phone, email
Tālrunis un e-pasts paziņojumiem.
reference
Jūsu pasūtījuma numurs: pēc tā atpazīstat pieturu tīmekļa āķī, un tas novērš dublikātus.
cod_amount, payment_required
Pēcmaksa mazākajā valūtas vienībā (forints: veseli forinti, eiro: centi).
date
Maršruta Ienākošie diena (GGGG-MM-DD). Pēc noklusējuma šodien.
route_id
Konkrēts maršruts Ienākošo vietā, ja to vēl var papildināt.
packages
Sūtījumu svītrkodi: vadītājs tos noskenē pirms piegādes.
require_photo, require_signature
Obligāts foto vai paraksts piegādes brīdī.

Tīmekļa āķi

Tīmekļa āķa adresi iestatāt tajā pašā lapā (tikai https), tur izvēlaties arī notikumus. Routehive par katru notikumu sūta JSON ar POST; saturs ir tāds pats kā pieturas statusa atbildē.

stop.delivered
Pietura piegādāta (ar iekasēto summu un foto un paraksta norādi).
stop.failed
Piegāde neizdevās (ar vadītāja piezīmi).
route.dispatched
Maršruts izsniegts vadītājam.
route.completed
Maršruts pabeigts.
{
  "event": "stop.delivered",
  "event_id": "stop_..._delivered_20261120143005123",
  "created_at": "2026-11-20T14:30:05Z",
  "data": {
    "id": "...",
    "route_id": "...",
    "reference": "WS-1001",
    "status": "delivered",
    "delivered_at": "2026-11-20T14:30:04Z",
    "note": null,
    "payment_required": true,
    "paid": true,
    "cod_amount": 12500,
    "collected_amount": 12500,
    "has_photo": true,
    "has_signature": false
  }
}

Paraksta pārbaude

Katram pieprasījumam ir galvene X-Routehive-Signature: t=laikspiedols,v1=paraksts. Paraksts ir HMAC-SHA256 no laikspiedola, punkta un neapstrādātā satura ar tīmekļa āķa noslēpumu. Ja tas nesakrīt, noraidiet pieprasījumu.

import { createHmac, timingSafeEqual } from "node:crypto";

// header: X-Routehive-Signature, body: the raw request body (string)
function verify(header, body, secret) {
  const { t, v1 } = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const expected = createHmac("sha256", secret).update(`${t}.${body}`).digest("hex");
  const fresh = Math.abs(Date.now() / 1000 - Number(t)) < 300;
  return fresh && timingSafeEqual(Buffer.from(v1, "hex"), Buffer.from(expected, "hex"));
}

Jebkura 2xx atbilde apstiprina saņemšanu. Kļūdu gadījumā mēģinām atkārtoti arvien retāk (1 minūte, 5 minūtes, 30 minūtes, 2 stundas, 12 stundas, 24 stundas). Pēc 50 kļūdām pēc kārtas tīmekļa āķis tiek izslēgts un īpašnieks saņem e-pastu.

Kļūdas un ierobežojumi

Kļūdas izskatās šādi: {"error": {"code": …, "message": …}}. Kods ir angliski, ziņojums jūsu uzņēmuma valodā. Katra atslēga var veikt 120 pieprasījumus minūtē; virs tā saņemat 429.

API un tīmekļa āķi

Šādi plānojiet rītdienas rīta maršrutus

Reģistrējieties, pievienojiet vadītājus, ielādējiet adreses. Bez maksas kopā 15 pieturas 2 maršrutos, kredītkarte nav nepieciešama.