Za programere

Specifikacija na kojoj možete graditi.

Open Brand Exchange je specifikacija s tri API-ja, JSON shemama, testnim podacima i testovima sukladnosti. Specifikacija je izvor istine; implementacije je slijede.

Referenca API-ja Specifikacija

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

Specifikacija

Verzija 0.1. OpenAPI 3.1, JSON Schema 2020-12, primjeri i izmišljena testna marka Kestrel Outfitters. Licenca CC-BY-4.0: slobodno za implementaciju, i komercijalno.

openbrandexchange/spec · Počnite s protocol.md

Tri API-ja

API	Za	Status	Ugovor
OBX Protocol	softver trgovaca: discovery, OAuth2 client credentials, tok promjena, pretraga po GTIN-u, renditions, izvozi, webhookovi	normativno	`obx-protocol.yaml` · HTML
OBX Ingest API	automatizacija marke: idempotentni upserti po vlastitim ID-jevima marke, prijenosi adresirani sha256, paketi, uvozi	normativno	`obx-ingest.yaml` · HTML
Node Admin + Portal API	zajednička administracija i portal za trgovce	nenormativno	`node-admin.yaml` · HTML

Čitanje portala marke u nekoliko redaka

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 i alat naredbenog retka

obx-go sadrži Go SDK (tipove, klijent protokola i ingest klijent s uklanjanjem duplikata, višedijelnim prijenosima i paketima), alat obx za marke, obx-conformance i lažni poslužitelj. U drugim jezicima dovoljan je bilo koji HTTP klijent: ugovor je u OpenAPI datotekama.

obx-go · obx

Sukladnost

Implementacija je sukladna s OBX-om za profil kad obx-conformance prođe sve obvezne testove tog profila. Postoje četiri profila: protocol, ingest, portal i 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

Implementacije

Repozitorij	Što	Licenca	Status
spec	specifikacija, sheme, testni podaci	CC-BY-4.0	0.1
obx-go	Go SDK, alat obx, testovi sukladnosti, lažni poslužitelj	Apache-2.0	0.1
admin-ui	zajedničko web sučelje: administracija i portal za trgovce	Apache-2.0	0.1
node-go	Portal za Google Cloud i Docker Go: Docker i Google Cloud Run	AGPL-3.0	0.1
node-php	Portal za web hosting PHP: običan web hosting	AGPL-3.0	0.1
node-ts	Portal za Cloudflare TypeScript: Cloudflare Workers	AGPL-3.0	0.1

Gradite vlastitu implementaciju ili klijent? Javite nam putem issuea ili pull requesta; ući će u tablicu čim prođe testove sukladnosti.

Dokumenti

Doprinosi idu putem pull requestova u repozitorij spec. Kako se donose odluke.