Đăng nhậpĐăng ký

API doanh nghiệp

REST API có phiên bản cho đồng bộ ERP. Xác thực bằng Authorization: Bearer gcn_live_… hoặc gcn_test_…. Tạo khóa trong bảng điều khiển Business.

Mới? Bắt đầu với checklist onboarding đối tác.

URL cơ sở

/api/v1

OpenAPI máy đọc được: /api/v1/openapi

Bộ sưu tập Postman: Tải / nhập

Endpoint chính

  • GET /meorg + scopes
  • 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}

Phạm vi

Khóa mới nhận tất cả scope. Có thể hạn chế chi tiết qua data model.

  • 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

Bắt đầu nhanh cho đối tác

Ví dụ curl từng bước cho sync catalog (mọi module), yêu cầu và webhook:

docs/api-partner-guide.md

Đầu dò sẵn sàng: /api/v1/ready

Ghi chú

  • Org chưa xác minh: tạo mới giữ PENDING đến khi admin duyệt.
  • Org đã xác minh: tạo/cập nhật API tự công bố ACTIVE.
  • Dùng externalId + Idempotency-Key cho retry ERP an toàn.
  • Bulk tối đa 200 mục/yêu cầu; webhook tối đa 3 lần với backoff.
  • Webhook ký HMAC (x-gcn-signature, x-gcn-timestamp).

Đang kiểm tra…