OTEP Protocolo Aberto Centro de Programadores Início
Protocolo Aberto

OTEP

Protocolo de evento de rastreamento aberto
Um Evento. Infinitas Jornadas.

Um protocolo de eventos aberto e neutro em relação a fornecedores para operações de rastreamento, entrega, fulfillment e logística. De transportadoras e estafetas a armazéns, cacifos, rotas e futuras redes de mobilidade, o OTEP fornece uma linguagem comum para todos os eventos operacionais.

Missão
Tornar os sistemas de logística interoperáveis através de uma linguagem de eventos partilhada.

O que é o OTEP?

O OTEP (Open Tracking Event Protocol) é um protocolo aberto e neutro em relação a fornecedores para o ciclo de vida de qualquer objeto rastreável. Iniciado e mantido pela Superroute, é gratuito para qualquer pessoa implementar. Unifica a entrega própria, a entrega por terceiros, o rastreamento de transportadoras, a prova de entrega, as exceções, as leituras em nós e a trajetória do motorista num único fluxo de eventos com um único vocabulário de estados — e foi concebido para se estender a mudanças, entrega de comida, armazenamento e muito mais.

O problema que resolve

O rastreamento está fragmentado. Cada transportadora nomeia os campos de forma diferente, cada canal de entrega vive no seu próprio silo, e ligar-se a padrões globais significa reintegrar uma e outra vez.

Vocabulários fragmentados

Cada transportadora usa os seus próprios códigos de estado e nomes de campos. Os consumidores escrevem mapeamentos à medida para cada integração.

Fontes em silos

Os seus próprios motoristas, as frotas de terceiros e as transportadoras de etiquetas reportam cada um o rastreamento num formato diferente, pelo que não existe uma única cronologia.

Sem interoperabilidade

Partilhar o rastreamento com parceiros em GS1 EPCIS, IATA ONE Record ou UN/CEFACT significa construir e manter uma exportação separada para cada um.

Como funciona

O OTEP é baseado em eventos: a cronologia de eventos é a fonte da verdade e o estado atual é apenas o evento mais recente. Cada evento é estruturado em torno de quatro dimensões — O Quê, Quando, Onde e Porquê — as mesmas dimensões partilhadas por EPCIS, ONE Record e UN/CEFACT, pelo que esses padrões se tornam simples projeções em vez de modelos paralelos. As fontes que expõem apenas um estado atual (sem histórico) são tratadas sintetizando um evento por cada mudança, para que uma lista de eventos em falta nunca seja um obstáculo.

What When Where Why

Funcionalidades principais

Cronologia unificada

A entrega própria, a entrega por terceiros e os envios por transportadora fundem-se numa única cronologia de eventos ordenada por número de rastreamento.

Um único vocabulário de estados

Um ciclo de vida normalizado de códigos de estado canónicos e fases, mapeado a partir de cada fonte — sem mais suposições por transportadora.

Interoperabilidade com padrões

Projete qualquer cronologia para GS1 EPCIS 2.0, IATA ONE Record ou UN/CEFACT com um único parâmetro de pedido.

Universal por conceção

Um protocolo geral com perfis de domínio — encomendas hoje; mudanças, entrega de comida e armazenamento a seguir — sobre uma espinha de eventos partilhada.

Aberto e neutro em relação a fornecedores

Uma especificação pública e versionada que qualquer pessoa pode implementar. Identificadores estáveis, uma taxonomia de estados publicada e uma máquina de estados.

Aditivo e sem quebras

Exposto através de uma nova API pública, a par da existente. Nada com que já se integra é alterado.

Pontos finais

Públicos, só de leitura, sob o prefixo /api/v1 existente. Adicione ?format= para uma projeção num padrão externo.

GET
https://api.superlabel.ca/api/v1/otep/trackings/{tracking_number}
A cronologia OTEP unificada para um número de rastreamento.
GET
https://api.superlabel.ca/api/v1/otep/trackings/{tracking_number}/events
Apenas a lista de eventos para um número de rastreamento.
POST
https://api.superlabel.ca/api/v1/otep/trackings/batch
Resolve vários números de rastreamento numa só chamada.

Formatos de saída

Uma cronologia à entrada, quatro representações à saída — escolhidas por ?format= ou por um perfil Accept.

format=otep

Cronologia OTEP nativa (predefinição).

format=epcis

GS1 EPCIS 2.0 ObjectEvents ( JSON-LD ).

format=onerecord

IATA ONE Registrar eventos logísticos ( JSON-LD ).

format=uncefact

Eventos de estado de transporte UN/CEFACT.

format=otlp

Rastreios OpenTelemetry OTLP — a jornada como um rastreio, cada evento um span.

format=aftership

Objeto de rastreamento compatível com AfterShip com pontos de verificação.

format=shopify

Lista Shopify FulfillmentEvent.

format=amazon

Histórico de eventos de rastreamento Amazon Shipping (SP-API).

format=walmart

Estado e rastreamento de linha de encomenda Walmart Marketplace (aproximado).

format=bigcommerce

Estado e rastreamento de encomenda BigCommerce (aproximado).

format=magento

Estado e rastreamento de encomenda Magento (aproximado).

format=woocommerce

Estado e rastreamento de encomenda WooCommerce (aproximado).

format=etsy

Estado de receção e rastreamento Etsy (aproximado).

format=sensorthings

Observações OGC SensorThings (IoT).

Ciclo de vida do estado

Cada evento mapeia para um estado canónico agrupado em fases — desde o pré-envio, passando pela recolha, trânsito e saída para entrega, até a um estado terminal (entregue, devolvido, recusado ou cancelado).

pre_shipment pickup inbound transit out_for_delivery delivered

O padrão aberto

O OTEP é publicado como uma especificação aberta — iniciada e mantida pela Superroute, gratuita para qualquer pessoa implementar. Não é um formato privado: o envelope de evento, a espinha de fases, o vocabulário de estados e a máquina de estados são o protocolo público e normativo.

Normativo vs informativo

O protocolo (envelope, vocabulário, máquina de estados, mapeamentos padrão) é normativo. As ligações de um implementador aos seus próprios sistemas internos são informativas e podem diferir.

Estável e versionado

Versionamento semântico. Adicionar códigos ou perfis é retrocompatível; o significado de um identificador publicado nunca muda. A versão do protocolo viaja com cada evento.

Identificadores estáveis

Os códigos são endereçados como otep:<profile>:<code> e as fases como otep:phase:<name>, para que o vocabulário se mantenha globalmente inequívoco entre implementadores.

Aberto e neutro em relação a fornecedores

Uma especificação pública que qualquer parte pode adotar, com uma licença aberta e um processo de extensão público — proponha novos perfis e códigos em vez de fazer um fork.

Construa uma implementação compatível

Os produtores e consumidores integram-se uma vez com o protocolo, não uma vez por transportadora. Quatro passos para uma implementação conforme.

1. Modele os eventos como O Quê / Quando / Onde / Porquê

Emita cada evento com o seu objeto (O Quê), a hora de ocorrência e de registo (Quando), a localização (Onde) e um estado canónico mais um motivo opcional (Porquê). Todos os campos exceto objeto, hora e estado são opcionais — preencha o que tiver.

2. Mapeie para o vocabulário canónico

Traduza os seus códigos de estado em bruto para códigos de estado e fases OTEP. As fontes que expõem apenas um estado atual sintetizam um evento por cada mudança.

3. Respeite a máquina de estados

Ordene os eventos pela hora de ocorrência, tolere chegadas fora de ordem e trate entregue / devolvido / recusado / cancelado como terminais. Marque os códigos experimentais com um prefixo x- até serem registados.

4. Consuma ou projete

Leia OTEP nativo, ou solicite uma projeção EPCIS / ONE Record / UN-CEFACT — o mesmo evento, um parâmetro. Um novo padrão de saída é apenas um novo serializador.

Níveis de conformidade

Level 1

Nível 1 — emita os códigos universais, as fases e as transições de estado válidas.

Level 2

Nível 2 — emita adicionalmente códigos específicos de perfil e pelo menos uma projeção num padrão externo.

Interoperabilidade internacional

As quatro dimensões do OTEP alinham-se campo a campo com os principais padrões globais, pelo que cada um se torna uma projeção de saída em vez de uma integração paralela.

GS1 EPCIS 2.0

Cada evento OTEP torna-se um ObjectEvent; o estado mapeia para CBV bizStep + disposition; a localização para readPoint. URNs padrão estáveis.

IATA ONE Record

Cada evento torna-se um LogisticsEvent com um eventCode e eventTimeType; a cronologia liga-se a um Shipment / Piece.

UN/CEFACT

Cada evento torna-se um TransportEvent com um código de estado de transporte sob um Consignment.

Mapeamento de campos (OTEP → padrão)
OTEPGS1 EPCIS 2.0IATA ONE RecordUN/CEFACT
occurred_ateventTimeeventDateOccurrence Date/Time
status_codebizStep + dispositioneventCodeTransport status code
locationreadPoint / bizLocationrecordedAtLocationLocation
subjectepcListlinkedObjectConsignment
incident_reasondispositionevent remarkStatus reason code

Os valores CBV do EPCIS são URNs padrão estáveis. Os valores de código ONE Record e UN/CEFACT são a melhor correspondência para a última milha e devem ser validados em relação às listas de códigos oficiais antes do uso externo.

Interoperabilidade futura Roteiro

O OTEP foi construído para continuar a absorver padrões. Estes estão no roteiro de interoperabilidade.

MCP IA
Exponha cronologias OTEP a assistentes de IA através de MCP para rastreamento em linguagem natural.
OGC SensorThings IoT
Ingira telemetria IoT OGC SensorThings (temperatura, localização, choque) como eventos de sensor OTEP.

Em avaliação: Outros marketplaces (TikTok Shop, Temu, Shein, e mais) estão a ser avaliados e serão adicionados à medida que as suas APIs públicas de fulfillment estabilizem.

Ainda não pode adotar o OTEP? Vamos na mesma interoperar.

Mesmo que não possa usar o padrão OTEP diretamente, por qualquer motivo, recebemo-lo de braços abertos para nos encontrarmos a meio caminho — e teremos todo o gosto em colaborar ao nível da interoperabilidade.

Recursos para programadores

Tudo o que precisa para construir e verificar uma integração conforme com o OTEP — especificação offline, esquema e codebook legíveis por máquina, um validador de conformidade ao vivo, uma configuração MCP e uma skill de desenvolvimento.

Ler online

Especificação

Leia a especificação normativa completa do protocolo no navegador.

Ver online

Codebook

Explore online cada código de estado, fase e mapeamento.

Ver online

Exemplos

Exemplos de integração prontos para copiar e colar.

Ver online

Validador de conformidade

Envie (POST) uma cronologia para verificar se está conforme; receba de volta os erros e avisos exatos.

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

Downloads offline

Comece a construir

Os endpoints OTEP estão ativos em /api/v1/otep. Explore-os na referência da API REST.

Abrir Referência da API