Automatizálás
Dolgozzon tovább úgy, ahogy most.
A PIM, ERP, DAM vagy egy megosztott mappa már tartalmazza az adatokat és a fotókat. Válassza az első megfelelő receptet: mind működik minden Open Brand Exchange-portállal.
$ obx push ./export
Publishing to brands.kestrel.example (Kestrel, Kestrel Trail)
images: 27 checked, 3 uploaded (4.2 MB) in 3s
Done: rows: 40, images: 27 → new: 2 · updated: 3 · unchanged: 35# .github/workflows/publish.yml
on:
push:
paths: ["export/**"]
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: openbrandexchange/obx-go/push-action@v0
with:
url: ${{ secrets.OBX_URL }}
token: ${{ secrets.OBX_TOKEN }}
folder: exportMelyik recept illik Önhöz?
| Önnek van… | Használja | Szükséges kód |
|---|---|---|
| CSV vagy zip egy webcímen, SFTP-szerveren vagy S3-tárolóban | Ütemezett import | nincs |
| egy mappa, ahová az exportok kerülnek | obx watch | nincs |
| egy szerver vagy PC, amely éjjel feladatokat futtat | cron vagy Feladatütemező | egy sor |
| exportok egy Git-tárolóban | GitHub Action | egy YAML-fájl |
| n8n, Make vagy Zapier | HTTP-lépések | nincs (vizuális) |
| egy fejlesztő, aki bekapcsolja a PIM-et vagy ERP-t | Közvetlenül az API | egy kevés |
Egy formátum mindenhez
Minden közzétételi mód ugyanazt olvassa: egy products.csv fájlt méretenként egy sorral, és {style}_{color}_{position}.jpg nevű fotókat (cikkszám, szín, pozíció). Ha ez megvan, minden lenti recept működik.
brand,style_number,name:en,name:nl,item_type,season,materials,color_code,color_name:en,size,gtin
Kestrel,KO-1001,Merino Crew Sweater,Merino trui met ronde hals,sweater,AW26,main: 100% merino_wool,NVY,Navy,S,2000100101018
Kestrel,KO-1001,Merino Crew Sweater,Merino trui met ronde hals,sweater,AW26,main: 100% merino_wool,NVY,Navy,M,2000100101025images/
KO-1001_NVY_1.jpg ← style KO-1001, colour NVY, position 1 (front)
KO-1001_NVY_2.jpg
KO-1001_NVY_3.jpgAmire szüksége van
Az adminisztrációban nyissa meg az Automatikus feltöltés → Hozzáférési kulcsokt, és hozzon létre új kulcsot. Két értéket kap: a portál címét (OBX_URL) és magát a kulcsot (OBX_TOKEN). A kulcs csak egyszer jelenik meg.
export OBX_URL=https://brands.kestrel.example
export OBX_TOKEN=obxi_… # admin → Automatic upload → Access keys (shown once)Minden rendszer kapjon saját kulcsot. Így egyet visszavonhat anélkül, hogy a többit elrontaná.
1. Ütemezett import (kód nélkül)
Az adminisztrációban: Automatikus feltöltés → Ütemezett importálások → Ütemezett importálás hozzáadása. Válassza ki a forrást és a gyakoriságot.
- Webcím (HTTPS): egy products.csv, vagy products.csv-t és fotókat tartalmazó zip címe. A belépési adatokat titkosítva tároljuk.
- SFTP: szerver, felhasználó, jelszó vagy kulcs, valamint az exportot tartalmazó mappa.
- S3-tároló: AWS S3, Cloudflare R2, MinIO vagy Backblaze: végpont, tároló, mappa és egy csak olvasható kulcs.
Válassza ezt: „Csak hozzáadás és frissítés” vagy ezt: „A hiányzó termékek visszavonása is”. A második azt is visszavonja, ami eltűnt a fájlból, de leáll, ha egy márka több mint fele eltűnne, így egy hibás export sosem üríti ki a katalógusát. A(z) „Kapcsolat tesztelése” megmutatja, mely fájlokat olvasná be.
Az obx eszköz
Az obx egyetlen program Windowsra, macOS-re és Linuxra. Az OBX_URL és OBX_TOKEN értékeket a környezetből olvassa, csak az új vagy módosult fotókat tölti fel, szükség esetén elkészíti a webes változatokat, és megvárja, amíg a portál mindent feldolgoz. Futtassa, amilyen gyakran csak akarja: a változatlan cikkek semmibe sem kerülnek.
obx info # check the token, see limits and brands
obx push --csv products.csv --images ./images # publish a CSV and a folder (or zip) of images
obx push --package export.zip # the same, as one zip
obx push --csv products.csv --images ./images --mirror # also take offline what is no longer in the file
obx push --csv products.csv --images ./images --dry-run # only check, change nothing
obx watch ./outbox # keep publishing whatever lands in a folder
obx status # recent jobs and their errorsKilépési kód 0 = minden rendben, 2 = kész, de néhány sorban hiba volt (listázva), 1 = sikertelen.
2. Egy mappa, amely magát publikálja: obx watch
A PIM, az ERP vagy egy kolléga mentse az exportokat egy mappába. Az obx watch azonnal publikál, ha valami változik, és kihagyja a változatlan fotókat. Futtassa szolgáltatásként vagy Dockerrel:
obx watch /data/outboxdocker run -d --restart unless-stopped \
-e OBX_URL -e OBX_TOKEN \
-v /data/outbox:/outbox \
ghcr.io/openbrandexchange/obx watch /outbox3. cron vagy a Windows Feladatütemező
# crontab -e: every night at 02:30
30 2 * * * OBX_URL=https://brands.kestrel.example OBX_TOKEN=obxi_… /usr/local/bin/obx push --csv /exports/products.csv --images /exports/images >> /var/log/obx.log 2>&1$action = New-ScheduledTaskAction -Execute "C:\Tools\obx.exe" -Argument "push --csv D:\Export\products.csv --images D:\Export\images"
$trigger = New-ScheduledTaskTrigger -Daily -At 2:30am
[Environment]::SetEnvironmentVariable("OBX_URL", "https://brands.kestrel.example", "Machine")
[Environment]::SetEnvironmentVariable("OBX_TOKEN", "obxi_…", "Machine")
Register-ScheduledTask -TaskName "Publish to OBX" -Action $action -Trigger $trigger -User "SYSTEM"4. GitHub Action
Mentse az OBX_URL és OBX_TOKEN értékeket a tároló titkos adataiként. Ugyanígy működik GitLab CI-ban, Bitbucketben és Azure DevOpsban: telepítse az obx-et, és futtassa az obx push parancsot.
# .github/workflows/publish.yml (secrets: OBX_URL, OBX_TOKEN)
name: Publish product content
on:
push:
branches: [main]
paths: ["export/**"]
schedule:
- cron: "30 2 * * *"
workflow_dispatch:
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install obx
run: |
curl -fsSL https://github.com/openbrandexchange/obx-go/releases/latest/download/obx_linux_amd64.tar.gz | tar -xz obx
sudo mv obx /usr/local/bin/
- name: Publish
env:
OBX_URL: ${{ secrets.OBX_URL }}
OBX_TOKEN: ${{ secrets.OBX_TOKEN }}
run: obx push --csv export/products.csv --assets-csv export/assets.csv --images export/images5. n8n, Make vagy Zapier
Használjon egy egyszerű HTTP Request lépést Authorization: Bearer fejléccel és a kulcsával. Minden lépés biztonságosan megismételhető: ugyanazon adatok kétszeri elküldése semmit sem változtat.
PUT {OBX_URL}/obx/v1/ingest/products/KO-1001
Authorization: Bearer obxi_…
Content-Type: application/json
{"style_number": "KO-1001",
"name": {"en": "Merino Crew Sweater", "nl": "Merino trui met ronde hals"},
"item_type": "sweater", "season": "AW26",
"materials": [{"part": "main", "fibers": [{"fiber": "merino_wool", "percentage": 100}]}]}PUT {OBX_URL}/obx/v1/ingest/variants/2000100101025
Authorization: Bearer obxi_…
Content-Type: application/json
{"product_external_id": "KO-1001", "gtin": "2000100101025",
"color": {"code": "NVY", "name": {"en": "Navy"}}, "size": "M"}PUT {OBX_URL}/obx/v1/ingest/assets/KO-1001_NVY_1
Authorization: Bearer obxi_…
Content-Type: application/json
{"product_external_id": "KO-1001", "color_code": "NVY",
"role": "packshot", "view": "front", "position": 1}
PUT {OBX_URL}/obx/v1/ingest/assets/KO-1001_NVY_1/files/original
Authorization: Bearer obxi_…
Content-Type: image/jpeg
<the image file as binary body>A Portál Cloudflare-re maga nem készít webes változatokat a fotókról. Ott az obx eszközzel vagy az adminisztráció „Importálások” menüpontjában publikáljon: ezek elkészítik Ön helyett. A más úton érkező fotók, például ütemezett importból, addig eredeti méretben jelennek meg.
PATCH {OBX_URL}/obx/v1/ingest/products/KO-1001
Authorization: Bearer obxi_…
Content-Type: application/merge-patch+json
{"status": "unpublished"}Szeretne jelzést kapni, ha történik valami? Az adminisztrációban adjon hozzá értesítést (webhook) egy befejezett importhoz vagy egy új hozzáférési kérelemhez, és indítson vele triggert az n8n-ben, a Make-ben vagy a Zapierben.
6. Közvetlenül az API (fejlesztőknek)
Egy integráció megjegyzi, mit küldött legutóbb, és csak a változásokat küldi, kötegekben. Vagy küldje el a CSV-t úgy, ahogy van, és hagyja, hogy a portál beolvassa.
URL="$OBX_URL/obx/v1/ingest"; AUTH="Authorization: Bearer $OBX_TOKEN"
# 1. Upload only the images the node does not have yet (addressed by sha256).
for f in images/*.jpg; do
sha=$(shasum -a 256 "$f" | cut -d' ' -f1)
curl -sf -I -H "$AUTH" "$URL/blobs/$sha" >/dev/null || \
curl -sf -X PUT -H "$AUTH" -H 'Content-Type: image/jpeg' --data-binary @"$f" "$URL/blobs/$sha"
done
# 2. One batch of up to 1000 operations (NDJSON), processed in order.
cat > batch.ndjson <<'EOF'
{"op":"upsert","kind":"product","external_id":"KO-1001","data":{"style_number":"KO-1001","name":{"en":"Merino Crew Sweater"}}}
{"op":"upsert","kind":"variant","external_id":"2000100101025","data":{"product_external_id":"KO-1001","gtin":"2000100101025","color":{"code":"NVY"},"size":"M"}}
{"op":"unpublish","kind":"product","external_id":"KO-0999"}
EOF
curl -s -X POST -H "$AUTH" -H 'Content-Type: application/x-ndjson' \
-H "Idempotency-Key: nightly-$(date +%F)" --data-binary @batch.ndjson "$URL/batch"curl -s -X POST -H "Authorization: Bearer $OBX_TOKEN" \
-F [email protected] -F [email protected] \
-F 'options={"mode":"upsert"};type=application/json' \
"$OBX_URL/obx/v1/ingest/imports" # returns a job; poll $OBX_URL/obx/v1/ingest/jobs/<id>Minden részlet a specifikációban található:Ingest API ·automatizálási receptek ·Go SDK ·Fejlesztőknek