OTEP Otvorený protokol Vývojárske centrum Domov
Otvorený protokol

OTEP

Otvorte protokol sledovania udalostí
Jedna udalosť. Nekonečné cesty.

Otvorený, na dodávateľovi nezávislý protokol udalostí pre sledovanie, doručovanie, fulfillment a logistické operácie. Od dopravcov a kuriérov až po sklady, schránky, trasy a budúce mobilné siete poskytuje OTEP spoločný jazyk pre každú prevádzkovú udalosť.

Poslanie
Umožniť interoperabilitu logistických systémov prostredníctvom spoločného jazyka udalostí.

Čo je OTEP?

OTEP (Open Tracking Event Protocol) je otvorený, na dodávateľovi nezávislý protokol pre životný cyklus akéhokoľvek sledovateľného subjektu. Iniciovaný a spravovaný spoločnosťou Superroute, je voľne implementovateľný pre kohokoľvek. Zjednocuje vlastné doručovanie, doručovanie treťou stranou, sledovanie dopravcov, potvrdenie o doručení, výnimky, skenovania uzlov a trajektóriu vodiča do jedného toku udalostí s jedným slovníkom stavov — a je navrhnutý tak, aby sa rozšíril na sťahovanie, rozvoz jedla, skladovanie a ďalej.

Problém, ktorý rieši

Sledovanie je roztrieštené. Každý dopravca pomenúva polia inak, každý doručovací kanál žije vo vlastnom silu a pripojenie ku globálnym štandardom znamená opakovanú integráciu znova a znova.

Roztrieštené slovníky

Každý dopravca používa vlastné stavové kódy a názvy polí. Spotrebitelia píšu mapovanie na mieru pre každú integráciu.

Izolované zdroje

Vaši vlastní vodiči, flotily tretích strán a dopravcovia so štítkami každý hlásia sledovanie v inej podobe, takže neexistuje žiadna jednotná časová os.

Žiadna interoperabilita

Zdieľanie sledovania s partnermi cez GS1 EPCIS, IATA ONE Record alebo UN/CEFACT znamená vytvárať a udržiavať samostatný export pre každý z nich.

Ako to funguje

OTEP je založený na udalostiach: časová os udalostí je zdrojom pravdy a aktuálny stav je len posledná udalosť. Každá udalosť je tvarovaná okolo štyroch rozmerov — Čo, Kedy, Kde a Prečo — tých istých rozmerov zdieľaných štandardmi EPCIS, ONE Record a UN/CEFACT, takže tieto štandardy sa stávajú jednoduchými projekciami namiesto paralelných modelov. Zdroje, ktoré vystavujú len aktuálny stav (bez histórie), sa spracúvajú syntetizovaním jednej udalosti na každú zmenu, takže chýbajúci zoznam udalostí nikdy nie je prekážkou.

What When Where Why

Kľúčové funkcie

Jednotná časová os

Vlastné doručovanie, doručovanie treťou stranou a zásielky dopravcov sa zlučujú do jednej usporiadanej časovej osi udalostí pre každé sledovacie číslo.

Jeden slovník stavov

Normalizovaný životný cyklus kanonických stavových kódov a fáz, namapovaný z každého zdroja — žiadne ďalšie hádanie pre jednotlivých dopravcov.

Interoperabilita štandardov

Premietnite akúkoľvek časovú os do GS1 EPCIS 2.0, IATA ONE Record alebo UN/CEFACT jediným parametrom požiadavky.

Univerzálny od základu

Všeobecný protokol s doménovými profilmi — dnes balíky; nabudúce sťahovanie, rozvoz jedla a skladovanie — nad jednou zdieľanou chrbticou udalostí.

Otvorený a nezávislý od dodávateľa

Verejná, verzionovaná špecifikácia, ktorú môže implementovať ktokoľvek. Stabilné identifikátory, publikovaná taxonómia stavov a stavový automat.

Aditívny a bez narušenia

Vystavený cez nové verejné API popri existujúcom. Nič, s čím už máte integráciu, sa nemení.

Koncové body

Verejné, len na čítanie, pod existujúcou predponou /api/v1. Pridajte ?format= pre projekciu do externého štandardu.

GET
https://api.superlabel.ca/api/v1/otep/trackings/{tracking_number}
Jednotná časová os OTEP pre sledovacie číslo.
GET
https://api.superlabel.ca/api/v1/otep/trackings/{tracking_number}/events
Iba zoznam udalostí pre sledovacie číslo.
POST
https://api.superlabel.ca/api/v1/otep/trackings/batch
Vyriešte mnoho sledovacích čísel v jednom volaní.

Výstupné formáty

Jedna časová os dnu, štyri reprezentácie von — zvolené cez ?format= alebo profil Accept.

format=otep

Natívna časová os OTEP (predvolené).

format=epcis

GS1 EPCIS 2.0 ObjectEvents ( JSON-LD ).

format=onerecord

IATA ONE Záznam logistických udalostí ( JSON-LD ).

format=uncefact

UN/CEFACT udalosti stavu prepravy.

format=otlp

OpenTelemetry OTLP trasy — cesta ako trasa, každá udalosť ako span.

format=aftership

Sledovací objekt kompatibilný s AfterShip s kontrolnými bodmi.

format=shopify

Zoznam Shopify FulfillmentEvent.

format=amazon

História sledovacích udalostí Amazon Shipping (SP-API).

format=walmart

Stav riadku objednávky a sledovanie Walmart Marketplace (hrubé).

format=bigcommerce

Stav objednávky a sledovanie BigCommerce (hrubé).

format=magento

Stav objednávky a sledovanie Magento (hrubé).

format=woocommerce

Stav objednávky a sledovanie WooCommerce (hrubé).

format=etsy

Stav potvrdenia a sledovanie Etsy (hrubé).

format=sensorthings

Pozorovania OGC SensorThings (IoT).

Životný cyklus stavu

Každá udalosť sa mapuje na kanonický stav zoskupený do fáz — od pred-odoslaním cez vyzdvihnutie, prepravu a doručovanie až po koncový stav (doručené, vrátené, odmietnuté alebo zrušené).

pre_shipment pickup inbound transit out_for_delivery delivered

Otvorený štandard

OTEP je publikovaný ako otvorená špecifikácia — iniciovaná a spravovaná spoločnosťou Superroute, voľne implementovateľná pre kohokoľvek. Nie je to súkromný formát: obálka udalosti, chrbtica fáz, slovník stavov a stavový automat sú verejný, normatívny protokol.

Normatívne vs informatívne

Protokol (obálka, slovník, stavový automat, štandardné mapovania) je normatívny. Väzby implementátora na jeho vlastné interné systémy sú informatívne a môžu sa líšiť.

Stabilné a verzionované

Sémantické verzionovanie. Pridávanie kódov alebo profilov je spätne kompatibilné; význam publikovaného identifikátora sa nikdy nemení. Verzia protokolu cestuje s každou udalosťou.

Stabilné identifikátory

Kódy sú adresované ako otep:<profile>:<code> a fázy ako otep:phase:<name>, takže slovník zostáva globálne jednoznačný naprieč implementátormi.

Otvorený a nezávislý od dodávateľa

Verejná špecifikácia, ktorú môže prijať ktorákoľvek strana, s otvorenou licenciou a verejným procesom rozšírenia — namiesto vetvenia navrhnite nové profily a kódy.

Vytvorte kompatibilnú implementáciu

Producenti a konzumenti sa integrujú raz proti protokolu, nie raz na každého dopravcu. Štyri kroky ku konformnej implementácii.

1. Modelujte udalosti ako Čo / Kedy / Kde / Prečo

Vyšlite každú udalosť s jej subjektom (Čo), časom výskytu a záznamu (Kedy), polohou (Kde) a kanonickým stavom plus voliteľným dôvodom (Prečo). Každé pole okrem subjektu, času a stavu je voliteľné — vyplňte, čo máte.

2. Mapujte na kanonický slovník

Preložte svoje surové stavové kódy na stavové kódy a fázy OTEP. Zdroje, ktoré vystavujú len aktuálny stav, syntetizujú jednu udalosť na každú zmenu.

3. Rešpektujte stavový automat

Usporiadajte udalosti podľa času výskytu, tolerujte príchod mimo poradia a považujte delivered / returned / rejected / cancelled za koncové. Experimentálne kódy označte predponou x- až do registrácie.

4. Konzumujte alebo premietnite

Čítajte natívny OTEP alebo požiadajte o projekciu EPCIS / ONE Record / UN-CEFACT — tá istá udalosť, jeden parameter. Nový výstupný štandard je len nový serializér.

Úrovne konformity

Level 1

Úroveň 1 — vyšlite univerzálne kódy, fázy a platné prechody stavov.

Level 2

Úroveň 2 — navyše vyšlite kódy špecifické pre profil a aspoň jednu projekciu do externého štandardu.

Medzinárodná interoperabilita

Štyri rozmery OTEP sa pole po poli zhodujú s hlavnými globálnymi štandardmi, takže každý sa stáva výstupnou projekciou namiesto paralelnej integrácie.

GS1 EPCIS 2.0

Každá udalosť OTEP sa stáva ObjectEvent; stav sa mapuje na CBV bizStep + disposition; poloha na readPoint. Stabilné štandardné URN.

IATA ONE Record

Každá udalosť sa stáva LogisticsEvent s eventCode a eventTimeType; časová os sa pripája k Shipment / Piece.

UN/CEFACT

Každá udalosť sa stáva TransportEvent s kódom stavu prepravy pod Consignment.

Mapovanie polí (OTEP → štandard)
OTEPGS1 EPCIS 2.0IATA ONE RecordUN/CEFACT
occurred_ateventTimeeventDateOccurrence Date/Time
status_codebizStep + dispositioneventCodeTransport status code
locationreadPoint / bizLocationrecordedAtLocationLocation
subjectepcListlinkedObjectConsignment
incident_reasondispositionevent remarkStatus reason code

Hodnoty EPCIS CBV sú stabilné štandardné URN. Hodnoty kódov ONE Record a UN/CEFACT sú najlepším priblížením pre poslednú míľu a pred externým použitím by mali byť overené oproti oficiálnym zoznamom kódov.

Budúca interoperabilita Plán

OTEP je vytvorený tak, aby neustále absorboval štandardy. Tieto sú na pláne interoperability.

MCP AI
Sprístupnite časové osi OTEP asistentom AI cez MCP pre sledovanie v prirodzenom jazyku.
OGC SensorThings IoT
Príjem telemetrie IoT OGC SensorThings (teplota, poloha, otras) ako senzorové udalosti OTEP.

V hodnotení: Ďalšie trhoviská (TikTok Shop, Temu, Shein a ďalšie) sa hodnotia a budú pridané, keď sa ich verejné fulfillment API ustália.

Zatiaľ nemôžete prijať OTEP? Aj tak buďme interoperabilní.

Aj keď nemôžete použiť štandard OTEP priamo, z akéhokoľvek dôvodu, srdečne vás vítame, aby ste nám vyšli v ústrety — a radi spolupracujeme na úrovni interoperability.

Vývojárske zdroje

Všetko, čo potrebujete na vytvorenie a overenie integrácie konformnej s OTEP — offline špecifikácia, strojovo čitateľná schéma a kódovník, živý validátor konformity, konfigurácia MCP a vývojárska zručnosť.

Čítať online

Offline súbory na stiahnutie

Začnite stavať

Koncové body OTEP sú aktívne pod /api/v1/otep. Preskúmajte ich v referencii REST API.

Otvoriť referenciu API