Pro vývojáře

Specifikace, na které můžete stavět.

Open Brand Exchange je specifikace se třemi API, schématy JSON, testovacími daty a testy shody. Specifikace je zdrojem pravdy; implementace se jí řídí.

Reference API Specifikace

Terminal

$ curl https://brands.kestrel.example/.well-known/obx

200 OK · application/json

{
  "obx_version": "0.1",
  "publisher": { "name": "Kestrel Outfitters" },
  "api_base": "https://brands.kestrel.example/obx/v1",
  "portal_url": "https://brands.kestrel.example/",
  "capabilities": ["changes", "products", "by_gtin",
                   "renditions", "exports", "webhooks"]
}

Specifikace

Verze 0.1. OpenAPI 3.1, JSON Schema 2020-12, příklady a fiktivní testovací značka Kestrel Outfitters. Licence CC-BY-4.0: volně implementovatelné, i komerčně.

openbrandexchange/spec · Začněte souborem protocol.md

Tři API

API	Pro	Stav	Kontrakt
OBX Protocol	software prodejců: discovery, OAuth2 client credentials, kanál změn, vyhledání podle GTIN, renditions, exporty, webhooky	normativní	`obx-protocol.yaml` · HTML
OBX Ingest API	automatizace značky: idempotentní upserty podle vlastních ID značky, nahrávání adresované sha256, dávky, importy	normativní	`obx-ingest.yaml` · HTML
Node Admin + Portal API	sdílená administrace a portál pro prodejce	nenormativní	`node-admin.yaml` · HTML

Čtení portálu značky na pár řádcích

HOST=https://brands.kestrel.example
curl -s $HOST/.well-known/obx                       # what does this brand offer?
TOKEN=$(curl -s -u "$CLIENT_ID:$CLIENT_SECRET" -d grant_type=client_credentials \
  $HOST/obx/v1/oauth/token | jq -r .access_token)
curl -s -H "Authorization: Bearer $TOKEN" "$HOST/obx/v1/changes?limit=500"   # everything, then only changes
curl -s -H "Authorization: Bearer $TOKEN" -X POST -H 'Content-Type: application/json' \
  -d '{"gtins":["2000100101025"]}' "$HOST/obx/v1/products:by-gtin"
# or let the obx tool keep a copy in a folder, only fetching what changed:
OBX_CLIENT_ID=$CLIENT_ID OBX_CLIENT_SECRET=$CLIENT_SECRET obx pull $HOST --out ./kestrel

SDK a nástroj pro příkazovou řádku

obx-go obsahuje Go SDK (typy, klienta protokolu a ingest klienta s deduplikací, vícedílným nahráváním a dávkami), nástroj obx pro značky, obx-conformance a mock server. V jiných jazycích stačí jakýkoli HTTP klient: kontrakt je v souborech OpenAPI.

obx-go · obx

Shoda

Implementace je v souladu s OBX pro daný profil, když obx-conformance projde všemi povinnými testy tohoto profilu. Existují čtyři profily: protocol, ingest, portal a security. conformance.md

obx-conformance all --url http://localhost:8080 --setup-code …   # a fresh portal: setup, fixtures, every profile
obx-conformance protocol --url https://brands.kestrel.example --client-id obxc_… --client-secret obxs_…
obx-conformance mock                                              # a mock server that passes everything

Implementace

Repozitář	Co	Licence	Stav
spec	specifikace, schémata, testovací data	CC-BY-4.0	0.1
obx-go	Go SDK, nástroj obx, testy shody, mock server	Apache-2.0	0.1
admin-ui	sdílené webové rozhraní: administrace a portál pro prodejce	Apache-2.0	0.1
node-go	Portál pro Google Cloud a Docker Go: Docker a Google Cloud Run	AGPL-3.0	0.1
node-php	Portál pro webhosting PHP: běžný webhosting	AGPL-3.0	0.1
node-ts	Portál pro Cloudflare TypeScript: Cloudflare Workers	AGPL-3.0	0.1

Stavíte vlastní implementaci nebo klienta? Dejte vědět přes issue nebo pull request; do tabulky se dostane, jakmile projde testy shody.

Dokumenty

Příspěvky probíhají přes pull requesty v repozitáři spec. Jak se přijímají rozhodnutí.