Automatizare
Lucrați în continuare ca acum.
PIM-ul, ERP-ul, DAM-ul sau un folder partajat are deja datele și fotografiile. Alegeți prima rețetă potrivită: toate funcționează cu orice portal Open Brand Exchange.
$ 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: exportCe rețetă vi se potrivește?
| Aveți… | Folosiți | Cod necesar |
|---|---|---|
| un CSV sau zip la o adresă web, pe un server SFTP sau într-un bucket S3 | Import programat | deloc |
| un folder în care ajung exporturile | obx watch | deloc |
| un server sau PC care rulează sarcini noaptea | cron sau Planificatorul de activități | un rând |
| exporturile într-un depozit Git | GitHub Action | un fișier YAML |
| n8n, Make sau Zapier | Pași HTTP | deloc (vizual) |
| un dezvoltator care conectează PIM-ul sau ERP-ul | API-ul direct | puțin |
Un singur format pentru tot
Orice metodă de publicare citește același lucru: un products.csv cu un rând pe mărime și fotografii numite {style}_{color}_{position}.jpg (model, culoare, poziție). Odată ce aveți asta, funcționează toate rețetele de mai jos.
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.jpgDe ce aveți nevoie
În administrare, deschideți Încărcare automată → Chei de acces și creați o cheie nouă. Veți avea două valori: adresa portalului (OBX_URL) și cheia însăși (OBX_TOKEN). Cheia este afișată o singură dată.
export OBX_URL=https://brands.kestrel.example
export OBX_TOKEN=obxi_… # admin → Automatic upload → Access keys (shown once)Dați fiecărui sistem propria cheie. Așa puteți revoca una fără să le afectați pe celelalte.
1. Import programat (fără cod)
În administrare: Încărcare automată → Importuri programate → Adaugă import programat. Alegeți sursa și cât de des rulează.
- Adresă web (HTTPS): adresa unui products.csv sau a unei arhive zip cu products.csv și fotografii. Datele de autentificare sunt stocate criptat.
- SFTP: server, utilizator, parolă sau cheie și folderul cu exportul.
- Bucket S3: AWS S3, Cloudflare R2, MinIO sau Backblaze: endpoint, bucket, folder și o cheie doar pentru citire.
Alegeți „Doar adaugă și actualizează” sau „Retrage și articolele lipsă”. A doua opțiune retrage și ce a dispărut din fișier, dar se oprește dacă ar dispărea mai mult de jumătate dintr-o marcă, ca un export defect să nu vă golească niciodată catalogul. „Testează conexiunea” arată ce fișiere ar citi.
Instrumentul obx
obx este un singur program pentru Windows, macOS și Linux. Citește OBX_URL și OBX_TOKEN din mediu, încarcă doar fotografiile noi sau modificate, creează versiunile web când e nevoie și așteaptă până când portalul a procesat totul. Rulați-l cât de des doriți: articolele nemodificate nu costă nimic.
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 errorsCod de ieșire 0 = totul în regulă, 2 = gata, dar unele rânduri au avut erori (sunt listate), 1 = eșuat.
2. Un folder care se publică singur: obx watch
Lăsați PIM-ul, ERP-ul sau un coleg să salveze exporturile într-un folder. obx watch publică imediat ce ceva se schimbă și sare peste fotografiile rămase la fel. Rulați-l ca serviciu sau cu Docker:
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 sau Planificatorul de activități Windows
# 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
Salvați OBX_URL și OBX_TOKEN ca secrete ale depozitului. La fel funcționează în GitLab CI, Bitbucket sau Azure DevOps: instalați obx și rulați obx push.
# .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 sau Zapier
Folosiți un pas HTTP Request obișnuit cu antetul Authorization: Bearer urmat de cheia dvs. Fiecare pas poate fi repetat în siguranță: trimiterea acelorași date de două ori nu schimbă nimic.
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>Portal pentru Cloudflare nu creează singur versiuni web ale fotografiilor. Publicați acolo cu obx sau prin „Importuri” în administrare: acestea le creează pentru dvs. Fotografiile care sosesc altfel, de exemplu printr-un import programat, sunt afișate până atunci la dimensiunea originală.
PATCH {OBX_URL}/obx/v1/ingest/products/KO-1001
Authorization: Bearer obxi_…
Content-Type: application/merge-patch+json
{"status": "unpublished"}Vreți să fiți anunțat când se întâmplă ceva? În administrare, adăugați o notificare (webhook) pentru un import finalizat sau o nouă cerere de acces și folosiți-o ca declanșator în n8n, Make sau Zapier.
6. API-ul direct (pentru dezvoltatori)
O integrare ține minte ce a trimis ultima dată și trimite doar modificările, în loturi. Sau trimiteți CSV-ul așa cum este și lăsați portalul să îl citească.
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>Toate detaliile sunt în specificație:Ingest API ·rețete de automatizare ·SDK Go ·Pentru dezvoltatori