Zeo API és webhookok

Fejlesztői platform Jellemzők

Minden, amire szüksége van az útvonaltervezés integrálásához az alkalmazásaiba

REST API

Teljes funkcionalitású RESTful API útvonalak, megállók, sofőrök és egyebek kezeléséhez. JSON kérés/válasz formátum átfogó dokumentációval.
- Útvonalak programozott létrehozása és optimalizálása
- Megállók, sofőrök és járművek kezelése
- Valós idejű követési adatok lekérése
- Hozzáférés elemzésekhez és jelentésekhez
- Tömeges műveletek támogatása
Webhook események

Valós idejű eseményértesítések küldve a végpontokra. Azonnal reagálhat az útvonalváltozásokra, a leállások befejeződésére és az illesztőprogram-frissítésekre.
- Útvonal megkezdése/befejezése események
- Állapotváltozási értesítések leállítása
- Sofőr tartózkodási helyének frissítései
- Értesítések a várható érkezés változásáról
Hitelesítés

Biztonságos API-hozzáférés iparági szabványnak megfelelő hitelesítéssel. Több kulcstípus a különböző hozzáférési szintekhez és felhasználási esetekhez.
- Tulajdonosi token hitelesítés
- API kulcskezelő irányítópult
- Kulcsonkénti hatókörön belüli engedélyek
- Kulcsforgatás támogatása
- Kulcsonkénti sebességkorlátozás
Harmadik féltől származó import

Zökkenőmentesen importálhat rendeléseket és megbízásokat külső rendszerekből. Automatikus címellenőrzés és geokódolás importáláskor.
- Tömeges leállítási import végpont
- Címérvényesítés és geokódolás
- Egyéni mezőleképezés
- Ismétlődő észlelés
- Importállapot-követés

webhook Események

Iratkozzon fel valós idejű eseményekre, és azonnal reagáljon az útvonalváltozásokra

Keret 1707478314 20 1, Zeo Útvonaltervező

útvonal.kezdve

Akkor aktiválódik, amikor a sofőr megkezdi az útvonal bejárását. Tartalmazza az útvonal azonosítóját, a sofőr adatait és a várható befejezési időt.

1707478314 19. keret, Zeo útvonaltervező

stop.completed

Akkor aktiválódik, amikor egy megállást teljesítettként jelölnek meg. Tartalmazza a szolgáltatási adatok igazolását, időbélyegeket és megjegyzéseket.

1707478314 17. keret, Zeo útvonaltervező

stop.failed

Akkor küldték, ha egy megállást nem lehetett végrehajtani. Tartalmazza a hiba okát és az esetlegesen rögzített fényképeket/jegyzeteket.

illesztőprogram.helyfrissítés

Időszakos helyfrissítések az aktív sofőrök számára. Konfigurálható gyakoriság 30 másodperctől 5 percig.

eta.változott

Akkor aktiválódik, ha a várható érkezési idők jelentősen megváltoznak a forgalom vagy a késések miatt.

útvonal.készült

Akkor aktiválódik, amikor minden megállás megtörtént. Tartalmazza a végső statisztikákat, az időtartamot és a teljesítménymutatókat.

// Webhook hasznos adat példa
{
  "esemény": "stop.completed",
  "időbélyeg": "2024-01-15T14:32:00Z",
  "adat"{
    "útvonal_azonosító": "útvonal_abc123",
    "stop_id": "stop_xyz789",
    "sofőr"{
      "id": "drv_456",
      "név": "John Smith"
    },
    "befejezve_ ekkor": "2024-01-15T14:31:45Z",
    "bizonyíték"{
      "aláírás": "https://...",
      "fotók": ["https://..."],
      "jegyzetek": "Az ajtóban hagyva"
    } } }

API-végpontok Áttekintés

Az útvonaltervezés és a flottakezelés alapvető végpontjai

POST

/v1/útvonalak

Új útvonal létrehozása megállók és optimalizálási beállításokkal

GET

/v1/routes/{azonosító}

Útvonal részleteinek lekérése, beleértve az optimalizált sorrendet

POST

/v1/routes/{id}/optimize

Meglévő útvonal újraoptimalizálása frissített paraméterekkel

GET

/v1/routes/{id}/tracking

Valós idejű követési adatok beszerzése az aktív útvonalról

POST

/v1/stops/import

Tömeges importálás leáll külső rendszerekből

PUT

/v1/stops/{id}/status

Leállítási állapot frissítése (befejezett, sikertelen, kihagyott)

GET

/v1/illesztőprogramok

Az összes elérhetőségi állapotú sofőr listázása

GET

/v1/drivers/{id}/location

Aktuális tartózkodási hely és útvonal előrehaladásának lekérése

POST

/v1/webhookok

Webhook végpont regisztrálása eseményértesítésekhez

Kód Példák

Gyorsan elkezdhetsz a kedvenc nyelveden írt példákkal

// Több megállós útvonal létrehozása és optimalizálása
const Útvonal létrehozása = aszinkron () => {
  const válasz = várják fetch(„https://api.zeoroute.com/v1/routes”, { metódus: 'POST', fejlécek: {
      „Engedélyezés”: `${process.env.ZEO_API_KEY} hordozó`,
      „Tartalomtípus”: 'alkalmazás/json'
    }, törzs: JSON.stringify({ név: „Reggeli kézbesítések”, illesztőprogram-azonosító: 'drv_123', optimalizálás: igaz, kezdő_hely: { cím: „123 Warehouse St, City”
      }, megáll: [ { cím: '456 Customer Ave', időablak: { kezdés: 09:00, vége: 12:00 }, szolgáltatási_idő: 15
        }, { cím: '789 Üzleti körút', prioritás: 'magas', szolgáltatási_idő: 30
        } ] }) });

  const útvonal = várják response.json(); console.log('Optimalizált útvonal:', útvonal.optimalizált_szekvencia);
  visszatérés útvonal; };

# Hozz létre és optimalizálj egy útvonalat több megállóból
importál kéri
importál os API_KEY = os.environ.get('ZEO_API_KEY') ALAP_URL = „https://api.zeoroute.com/v1”

fejlécek = {
    „Engedélyezés”: f'Bearer {API_KEY}',
    „Tartalomtípus”: 'alkalmazás/json'
} útvonaladatok = {
    'név': „Reggeli kézbesítések”,
    'vezető_azonosító': 'drv_123',
    optimalizálás: Igaz,
    'kezdőhely'{
        'cím': „123 Warehouse St, City”
    },
    'megáll': [ {
            'cím': '456 Customer Ave',
            'időablak'{'indul': 09:00, 'vége': 12:00},
            'szolgáltatás_ideje': 15
        }, {
            'cím': '789 Üzleti körút',
            'prioritás': 'magas',
            'szolgáltatás_ideje': 30
        } ] } válasz = kérések.post(
    f'{ALAP_URL}/útvonalak, fejlécek=fejlécek, json=útvonal_adatok ) útvonal = válasz.json() print('Optimalizált útvonal:', útvonal['optimalizált_szekvencia'])

# Hozz létre és optimalizálj egy útvonalat több megállóból
curl -X POST "https://api.zeoroute.com/v1/routes" \ -H "Engedélyezés: $ZEO_API_KEY tulajdonos" \ -H "Tartalomtípus: application/json" \ -d '{ "name": "Reggeli kiszállítások", "driver_id": "drv_123", "optimize": true, "start_location": { "address": "123 Warehouse St, Város" }, "stops": [ { "address": "456 Customer Ave", "time_window": {"start": "09:00", "end": "12:00"}, "service_time": 15 }, { "address": "789 Business Blvd", "priority": "high", "service_time": 30 } ] }'

# Útvonal részleteinek lekérése
curl -X GET "https://api.zeoroute.com/v1/routes/route_abc123" \ -H "Engedélyezés: $ZEO_API_KEY tulajdonos"

# Megállási állapot frissítése
curl -X PUT "https://api.zeoroute.com/v1/stops/stop_xyz789/status" \ -H "Engedélyezés: $ZEO_API_KEY tulajdonos" \ -H "Tartalomtípus: application/json" \ -d '{"status": "completed", "notes": "Az ajtóban hagyva"}'

Integráció Használati esetek

Az automatikus frissítések minden iparágban működnek ütemezett látogatásokkal

SZÁLLÍTÁS

Rendeléskezelési integráció

Egy e-kereskedelmi platform óránként automatikusan importálja az új megrendeléseket API-n keresztül. A megrendeléseket régiónként csoportosítja, útvonalak szerint optimalizálja, és a futároknak küldi. A webhook értesítések valós időben frissítik a megrendelések állapotát a szállítások befejeződésével.

TEREP MUNKA

CRM-vezérelt szolgáltatásütemezés

Egy terepi szolgáltatásokat nyújtó cég API-n keresztül szinkronizálja a munkamegrendeléseket a CRM-jéből. Az új feladatok automatikusan létrehoznak leállásokat az ügyféladatokkal, a szolgáltatási igényekkel és az időablakokkal. A befejezési webhookok frissítik a CRM-et és elindítják a számlázást.