Source document
docs/pilot/PARTNER-ONBOARDING-PACKAGE.md
Source version
0.0.0
Generated time
2026-07-06T14:59:19.735Z
Owner
Operations / Founder
Audience
Internal
Status
Approved

Partner Onboarding Package

Danh mục chính xác những gì một đối tác nhận được khi onboard. Không chứa secret.
Nguồn tài liệu: docs/integration/ (Partner Integration Kit) + docs/operations/.

1. Bộ tài liệu bàn giao (partner nhận)

Hạng mụcFileMô tả
Integration Guidedocs/integration/PARTNER-INTEGRATION-GUIDE.mdTổng quan kiến trúc, auth, error handling, retry, idempotency, booking lifecycle, best practices, troubleshooting.
OpenAPIdocs/integration/openapi.yamlContract máy-đọc (9 operation), khớp implementation.
Postman Collectiondocs/integration/bng-booking.postman_collection.json + .postman_environment.jsonHealth/Availability/Pricing/Booking/Confirm/Cancel + environment mẫu (không secret).
Code Samplesdocs/integration/examples/curl · JavaScript · Python, mỗi ví dụ chạy độc lập (đã kiểm chứng curl/flow.sh end-to-end).
Sandbox Checklistdocs/integration/PARTNER-SANDBOX-CHECKLIST.mdLộ trình 30 phút / 2 giờ / 1 ngày, mỗi bước có tiêu chí PASS.
Error Catalogdocs/integration/API-ERROR-CATALOG.mdMọi mã lỗi + HTTP status + hướng xử lý + ma trận retry.

2. Thông tin kết nối (BNG cấp riêng cho từng partner)

BNG bàn giao qua kênh onboarding (không nằm trong repo):

3. API Key Request Process

  1. Partner gửi BNG: tên tổ chức, môi trường (sandbox), IP egress (server sẽ gọi API).
  2. BNG:
  1. Partner nhận key + base URL + unit IDs + xác nhận allowlist → bắt đầu theo Sandbox Checklist.
Raw key hiển thị đúng một lần. Mất/lộ → BNG rotate-key. Không self-serve.

4. Support Contact Process

5. Điều kiện hoàn tất onboarding (Definition of Ready cho partner)