OTEP Otwarty protokół Centrum dla programistów Strona główna
Otwarty protokół

OTEP

Otwarty protokół zdarzenia śledzenia
Jedno zdarzenie. Nieskończenie wiele podróży.

Otwarty, niezależny od dostawcy protokół zdarzeń do śledzenia, doręczania, realizacji zamówień i operacji logistycznych. Od przewoźników i kurierów po magazyny, paczkomaty, trasy i przyszłe sieci mobilności — OTEP zapewnia wspólny język dla każdego zdarzenia operacyjnego.

Misja
Uczynienie systemów logistycznych interoperacyjnymi dzięki wspólnemu językowi zdarzeń.

Czym jest OTEP?

OTEP (Open Tracking Event Protocol) to otwarty, niezależny od dostawcy protokół obejmujący cykl życia dowolnego śledzonego obiektu. Zainicjowany i nadzorowany przez Superroute, jest bezpłatny do wdrożenia dla każdego. Ujednolica dostawę własną, dostawę zewnętrzną, śledzenie przewoźnika, potwierdzenie doręczenia, wyjątki, skany w węzłach i trajektorię kierowcy w jednym strumieniu zdarzeń z jednym słownikiem statusów — i został zaprojektowany tak, aby objąć przeprowadzki, dostawę jedzenia, przechowywanie i nie tylko.

Problem, który rozwiązuje

Śledzenie jest rozproszone. Każdy przewoźnik inaczej nazywa pola, każdy kanał dostawy żyje we własnym silosie, a połączenie z globalnymi standardami oznacza wciąż powtarzaną integrację.

Rozproszone słowniki

Każdy przewoźnik używa własnych kodów statusów i nazw pól. Odbiorcy piszą indywidualne mapowania dla każdej integracji.

Odizolowane źródła

Twoi własni kierowcy, floty zewnętrzne i przewoźnicy etykiet — każdy raportuje śledzenie w innej formie, więc nie istnieje jedna oś czasu.

Brak interoperacyjności

Udostępnianie śledzenia partnerom w GS1 EPCIS, IATA ONE Record lub UN/CEFACT oznacza budowanie i utrzymywanie osobnego eksportu dla każdego z nich.

Jak to działa

OTEP jest oparty na zdarzeniach: oś czasu zdarzeń jest źródłem prawdy, a bieżący status to po prostu najnowsze zdarzenie. Każde zdarzenie jest zbudowane wokół czterech wymiarów — Co, Kiedy, Gdzie i Dlaczego — tych samych wymiarów, które dzielą EPCIS, ONE Record i UN/CEFACT, dzięki czemu te standardy stają się prostymi projekcjami, a nie równoległymi modelami. Źródła, które udostępniają tylko bieżący status (bez historii), są obsługiwane przez syntetyzowanie jednego zdarzenia na każdą zmianę, więc brak listy zdarzeń nigdy nie jest przeszkodą.

What When Where Why

Kluczowe funkcje

Ujednolicona oś czasu

Dostawa własna, dostawa zewnętrzna i przesyłki przewoźników łączą się w jedną uporządkowaną oś czasu zdarzeń dla każdego numeru śledzenia.

Jeden słownik statusów

Znormalizowany cykl życia kanonicznych kodów statusów i faz, zmapowany z każdego źródła — koniec ze zgadywaniem dla każdego przewoźnika.

Interoperacyjność ze standardami

Rzutuj dowolną oś czasu na GS1 EPCIS 2.0, IATA ONE Record lub UN/CEFACT za pomocą jednego parametru żądania.

Uniwersalny z założenia

Ogólny protokół z profilami dziedzinowymi — dziś paczki; w przyszłości przeprowadzki, dostawa jedzenia i przechowywanie — na jednym wspólnym kręgosłupie zdarzeń.

Otwarty i niezależny od dostawcy

Publiczna, wersjonowana specyfikacja, którą każdy może wdrożyć. Stabilne identyfikatory, opublikowana taksonomia statusów i maszyna stanów.

Addytywny i nienaruszający

Udostępniany przez nowe publiczne API obok istniejącego. Nic, z czym już się integrujesz, się nie zmienia.

Punkty końcowe

Publiczne, tylko do odczytu, pod istniejącym prefiksem /api/v1. Dodaj ?format= dla projekcji w standardzie zewnętrznym.

GET
https://api.superlabel.ca/api/v1/otep/trackings/{tracking_number}
Ujednolicona oś czasu OTEP dla numeru śledzenia.
GET
https://api.superlabel.ca/api/v1/otep/trackings/{tracking_number}/events
Tylko lista zdarzeń dla numeru śledzenia.
POST
https://api.superlabel.ca/api/v1/otep/trackings/batch
Rozwiąż wiele numerów śledzenia w jednym wywołaniu.

Formaty wyjściowe

Jedna oś czasu na wejściu, cztery reprezentacje na wyjściu — wybierane przez ?format= lub profil Accept.

format=otep

Natywna oś czasu OTEP (domyślnie).

format=epcis

GS1 EPCIS 2.0 Zdarzenia obiektowe ( JSON-LD ).

format=onerecord

IATA ONE Rejestruj zdarzenia logistyczne ( JSON-LD ).

format=uncefact

Zdarzenia statusu transportu UN/CEFACT.

format=otlp

Ślady OpenTelemetry OTLP — podróż jako ślad, każde zdarzenie jako span.

format=aftership

Obiekt śledzenia zgodny z AfterShip z punktami kontrolnymi.

format=shopify

Lista Shopify FulfillmentEvent.

format=amazon

Historia zdarzeń śledzenia Amazon Shipping (SP-API).

format=walmart

Status pozycji zamówienia i śledzenie Walmart Marketplace (przybliżone).

format=bigcommerce

Status zamówienia i śledzenie BigCommerce (przybliżone).

format=magento

Stan zamówienia i śledzenie Magento (przybliżone).

format=woocommerce

Status zamówienia i śledzenie WooCommerce (przybliżone).

format=etsy

Status potwierdzenia i śledzenie Etsy (przybliżone).

format=sensorthings

Obserwacje OGC SensorThings (IoT).

Cykl życia statusu

Każde zdarzenie mapuje się na kanoniczny status pogrupowany w fazy — od przed wysyłką, przez odbiór, tranzyt i dostarczanie, aż po stan końcowy (doręczone, zwrócone, odrzucone lub anulowane).

pre_shipment pickup inbound transit out_for_delivery delivered

Otwarty standard

OTEP jest publikowany jako otwarta specyfikacja — zainicjowana i nadzorowana przez Superroute, bezpłatna do wdrożenia dla każdego. Nie jest to format prywatny: koperta zdarzenia, kręgosłup faz, słownik statusów i maszyna stanów stanowią publiczny, normatywny protokół.

Normatywne kontra informacyjne

Protokół (koperta, słownik, maszyna stanów, standardowe mapowania) jest normatywny. Powiązania implementatora z jego własnymi systemami wewnętrznymi są informacyjne i mogą się różnić.

Stabilny i wersjonowany

Wersjonowanie semantyczne. Dodawanie kodów lub profili jest wstecznie kompatybilne; znaczenie opublikowanego identyfikatora nigdy się nie zmienia. Wersja protokołu podróżuje z każdym zdarzeniem.

Stabilne identyfikatory

Kody są adresowane jako otep:<profile>:<code>, a fazy jako otep:phase:<name>, dzięki czemu słownik pozostaje globalnie jednoznaczny dla wszystkich implementatorów.

Otwarty i niezależny od dostawcy

Publiczna specyfikacja, którą może przyjąć każda strona, z otwartą licencją i publicznym procesem rozszerzania — proponuj nowe profile i kody zamiast tworzyć rozgałęzienia.

Zbuduj zgodną implementację

Producenci i odbiorcy integrują się raz z protokołem, a nie raz na przewoźnika. Cztery kroki do zgodnej implementacji.

1. Modeluj zdarzenia jako Co / Kiedy / Gdzie / Dlaczego

Emituj każde zdarzenie z jego podmiotem (Co), czasem wystąpienia i zapisu (Kiedy), lokalizacją (Gdzie) oraz kanonicznym statusem i opcjonalnym powodem (Dlaczego). Każde pole oprócz podmiotu, czasu i statusu jest opcjonalne — wypełnij to, co masz.

2. Mapuj na kanoniczny słownik

Przetłumacz swoje surowe kody statusów na kody statusów i fazy OTEP. Źródła udostępniające tylko bieżący status syntetyzują jedno zdarzenie na każdą zmianę.

3. Przestrzegaj maszyny stanów

Porządkuj zdarzenia według czasu wystąpienia, toleruj przybycie poza kolejnością i traktuj delivered / returned / rejected / cancelled jako stany końcowe. Oznaczaj kody eksperymentalne prefiksem x- aż do ich rejestracji.

4. Konsumuj lub rzutuj

Odczytuj natywny OTEP lub żądaj projekcji EPCIS / ONE Record / UN-CEFACT — to samo zdarzenie, jeden parametr. Nowy standard wyjściowy to po prostu nowy serializator.

Poziomy zgodności

Level 1

Poziom 1 — emituj uniwersalne kody, fazy i prawidłowe przejścia stanów.

Level 2

Poziom 2 — dodatkowo emituj kody specyficzne dla profilu oraz co najmniej jedną projekcję w standardzie zewnętrznym.

Międzynarodowa interoperacyjność

Cztery wymiary OTEP odpowiadają pole w pole głównym globalnym standardom, więc każdy z nich staje się projekcją wyjściową, a nie równoległą integracją.

GS1 EPCIS 2.0

Każde zdarzenie OTEP staje się ObjectEvent; status mapuje się na CBV bizStep + disposition; lokalizacja na readPoint. Stabilne standardowe URN-y.

IATA ONE Record

Każde zdarzenie staje się LogisticsEvent z eventCode i eventTimeType; oś czasu jest dołączana do Shipment / Piece.

UN/CEFACT

Każde zdarzenie staje się TransportEvent z kodem statusu transportu w ramach Consignment.

Mapowanie pól (OTEP → standard)
OTEPGS1 EPCIS 2.0IATA ONE RecordUN/CEFACT
occurred_ateventTimeeventDateOccurrence Date/Time
status_codebizStep + dispositioneventCodeTransport status code
locationreadPoint / bizLocationrecordedAtLocationLocation
subjectepcListlinkedObjectConsignment
incident_reasondispositionevent remarkStatus reason code

Wartości EPCIS CBV to stabilne standardowe URN-y. Wartości kodów ONE Record i UN/CEFACT są najlepszym dopasowaniem dla ostatniej mili i powinny zostać zweryfikowane względem oficjalnych list kodów przed użyciem zewnętrznym.

Przyszła interoperacyjność Mapa drogowa

OTEP został stworzony, aby nieustannie przyswajać standardy. Oto, co znajduje się na mapie drogowej interoperacyjności.

MCP AI
Udostępniaj osie czasu OTEP asystentom AI przez MCP do śledzenia w języku naturalnym.
OGC SensorThings IoT
Pobieraj telemetrię IoT OGC SensorThings (temperatura, lokalizacja, wstrząsy) jako zdarzenia czujników OTEP.

W ocenie: Inne platformy handlowe (TikTok Shop, Temu, Shein i więcej) są oceniane i zostaną dodane, gdy ich publiczne API realizacji zamówień się ustabilizują.

Nie możesz jeszcze w pełni przyjąć OTEP? Współpracujmy mimo to.

Nawet jeśli z jakiegokolwiek powodu nie możesz bezpośrednio korzystać ze standardu OTEP, serdecznie zapraszamy do spotkania się w połowie drogi — i chętnie współpracujemy na poziomie interoperacyjności.

Zasoby dla programistów

Wszystko, czego potrzebujesz, aby zbudować i zweryfikować integrację zgodną z OTEP — specyfikacja offline, schemat i kodeks do odczytu maszynowego, działający walidator zgodności, konfiguracja MCP oraz umiejętność deweloperska.

Czytaj online

Specyfikacja

Przeczytaj pełną normatywną specyfikację protokołu w przeglądarce.

Zobacz online

Codebook

Przeglądaj online każdy kod statusu, fazę i mapowanie.

Zobacz online

Przykłady

Gotowe przykłady integracji do skopiowania.

Zobacz online

Walidator zgodności

Wyślij (POST) oś czasu, aby sprawdzić jej zgodność; otrzymasz dokładne błędy i ostrzeżenia.

POST https://api.superlabel.ca/api/v1/otep/validate

Pliki do pobrania offline

Zacznij budować

Punkty końcowe OTEP są dostępne pod /api/v1/otep. Poznaj je w dokumentacji REST API.

Otwórz dokumentację API