API Perusahaan

API REST versi untuk penyelarasan ERP. Sahkan dengan Authorization: Bearer gcn_live_… atau gcn_test_…. Cipta kunci dalam papan pemuka Perniagaan anda.

Baru di sini? Mulakan dengan senarai semak onboarding rakan kongsi.

URL Asas

/api/v1

OpenAPI yang boleh dibaca mesin: /api/v1/openapi

Koleksi Postman: Muat turun / import

Titik akhir teras

GET /me — org + skop
GET|POST /listings, /listings/bulk
GET|POST /inventory, /inventory/bulk (syncMode: upsert|replace)
/freight, /freight/bulk · /depots, /depots/bulk · /storage, /storage/bulk · /manufacturers, /manufacturers/bulk · /ports, /ports/bulk
/inquiries, /inquiries/{id}/reply
/organization, /webhooks, /bulk/{jobId}

Skop

Kunci baru menerima semua skop. Sekatan halus tersedia melalui model data.

listings:read
listings:write
inventory:read
inventory:write
freight:read
freight:write
depots:read
depots:write
storage:read
storage:write
manufacturers:read
manufacturers:write
ports:read
ports:write
inquiries:read
inquiries:write
org:read
org:write
webhooks:manage
bulk:write

Permulaan cepat rakan kongsi

Contoh curl langkah demi langkah untuk penyelarasan katalog (semua modul), pertanyaan dan webhook:

docs/api-partner-guide.md

Probe kesiapan: /api/v1/ready

Nota

Organisasi yang tidak disahkan: penciptaan kekal PENDING sehingga admin meluluskan.
Disahkan organisasi: API mencipta/mengemas kini auto-publish sebagai ACTIVE.
Gunakan externalId + Idempotency-Key untuk percubaan ERP yang selamat.
Maksimum 200 item/permintaan; webhook mencuba semula sehingga 3 kali dengan backoff.
Webhook ditandatangani HMAC (x-gcn-signature, x-gcn-timestamp).