Udviklere

En specifikation, du kan bygge på.

Open Brand Exchange er en specifikation med tre API'er, JSON Schemas, testdata og konformitetstests. Specifikationen er kilden; implementeringerne følger den.

API-reference Specifikation

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"]
}

Specifikationen

Version 0.1. OpenAPI 3.1, JSON Schema 2020-12, eksempler og et fiktivt testbrand, Kestrel Outfitters. Licens CC-BY-4.0: frit at implementere, også kommercielt.

openbrandexchange/spec · Start med protocol.md

Tre API'er

API	Til	Status	Kontrakt
OBX Protocol	forhandleres software: discovery, OAuth2 client credentials, ændringsfeed, GTIN-opslag, renditions, eksporter, webhooks	normativ	`obx-protocol.yaml` · HTML
OBX Ingest API	et brands automatisering: idempotente upserts på brandets egne id'er, uploads adresseret med sha256, batches, importer	normativ	`obx-ingest.yaml` · HTML
Node Admin + Portal API	den fælles administration og forhandlerportalen	ikke-normativ	`node-admin.yaml` · HTML

Læs en brandportal på få linjer

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 og kommandolinjeværktøj

obx-go indeholder Go-SDK'et (typer, en protokolklient og en ingest-klient med deduplikering, multipart-uploads og batches), obx-værktøjet til brands, obx-conformance og en mockserver. I andre sprog virker enhver HTTP-klient: kontrakten står i OpenAPI-filerne.

obx-go · obx

Konformitet

En implementering er OBX-konform for en profil, når obx-conformance består alle obligatoriske tests i profilen. Der er fire profiler: protocol, ingest, portal og 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

Implementeringer

Repository	Hvad	Licens	Status
spec	specifikation, skemaer, testdata	CC-BY-4.0	0.1
obx-go	Go-SDK, obx-værktøj, konformitetstests, mockserver	Apache-2.0	0.1
admin-ui	fælles webgrænseflade: administration og forhandlerportal	Apache-2.0	0.1
node-go	Portal til Google Cloud og Docker Go: Docker og Google Cloud Run	AGPL-3.0	0.1
node-php	Portal til webhotel PHP: almindeligt webhotel	AGPL-3.0	0.1
node-ts	Portal til Cloudflare TypeScript: Cloudflare Workers	AGPL-3.0	0.1

Bygger du din egen implementering eller klient? Giv besked med et issue eller en pull request; den kommer i tabellen, så snart den består konformitetstestene.

Dokumenter

Bidrag sker via pull requests på spec-repositoriet. Hvordan beslutninger træffes.