Yêu cầu kinh doanh
Sản phẩm, market, user role, quy tắc tài chính, restriction và kết quả mong đợi.
Documentation / API Requirements
Cần chuẩn bị gì trước khi kết nối API
Thu thập thông tin về project, access, data, security và test scenario trước khi bắt đầu tích hợp. Điều này giúp xác định phạm vi từ sớm và tránh phải làm lại.
Phạm vi
sản phẩm và thị trường
Truy cập
key và environment
Dữ liệu
format và status
Nghiệm thu
kiểm tra scenario
Bộ yêu cầu
Những gì cần thống nhất trước khi bắt đầu công việc
01
Yêu cầu dự án
Sản phẩm, market, currency, provider, user và quy trình vận hành.
02
Quy tắc trao đổi dữ liệu
Request, field, ID, status, lỗi và event.
03
Access và security
Access key, request signature, allowed IP address, role và activity log.
04
Testing và nghiệm thu
Test data, scenario thành công và lỗi, xác minh kết quả và tiêu chí launch.
Tổng quan
Yêu cầu được thống nhất giúp giảm thời gian triển khai và làm lại
Trước khi bắt đầu, hai bên cần hiểu giống nhau về mục tiêu dự án, nguồn dữ liệu, operation status, trách nhiệm hệ thống, security rule và tiêu chí nghiệm thu. Khi đó tích hợp được thực hiện theo thiết kế đã thống nhất thay vì dựa trên giả định.
Quy tắc tích hợp
Phương thức trao đổi dữ liệu, cấu trúc request và response, ID, status, notification, lỗi và limit.
Tiêu chí nghiệm thu
Test scenario, dữ liệu dự kiến, report, operational monitoring và tiêu chí chuyển sang launch.
Dữ liệu dự án
Thông tin dự án và hệ thống được kết nối
Trước tiên xác định bối cảnh tổng thể: sản phẩm nào được kết nối, hệ thống nào tham gia, dữ liệu chính được lưu ở đâu và ai chịu trách nhiệm cho từng quy trình.
Phạm vi và mục tiêu dự án
Sản phẩm: casino, sports betting, payment, KYC, CRM, bonus, reporting hoặc Back Office.
Quốc gia, license, currency, language, brand và channel sử dụng.
User type, role, limit, status và scenario vận hành chính.
Priority, launch stage, chức năng quan trọng và ràng buộc thương mại.
Hệ thống và quyền sở hữu dữ liệu
Danh sách hệ thống nội bộ và bên ngoài tham gia quy trình.
System of record cho dữ liệu player, balance, transaction, bet, bonus hoặc KYC check.
API, database, message queue, notification, file và legacy interface hiện có.
Team phụ trách, contact vận hành và escalation procedure cho vấn đề phức tạp.
Yêu cầu tích hợp
Yêu cầu trao đổi dữ liệu qua API
Documentation phải cho phép hoàn tất tích hợp mà không cần phỏng đoán. Với mỗi giao dịch, cần mô tả trước mục đích, input data, kết quả, lỗi có thể xảy ra và retry rule.
Endpoint và request method
Base API URL, request path, HTTP method, parameter, header và mục đích của từng giao dịch.
Format request và response
Data type, required field, format ngày, độ chính xác amount, null value được phép và example.
Operation status
Toàn bộ lifecycle của giao dịch từ tạo đến hoàn tất, transition được phép và final state.
Lỗi và hành động
Error code, lý do rõ ràng, có được retry hay không và hành động cần thiết từ hệ thống nhận.
Event notification
Cấu trúc event, signing, delivery, acknowledgement, redelivery và thứ tự xử lý.
Bảo vệ duplicate
Operation ID duy nhất, nhận diện request lặp lại và recovery an toàn sau sự cố.
Limit và tải
Request rate, timeout, concurrent operation, response size và peak load dự kiến.
Thay đổi version
API version, backward compatibility, thời gian thông báo và change management procedure.
Security và access
Yêu cầu security và access management
Trước khi truyền production data, cần thống nhất authentication method, request signing, network restriction, user permission, key storage và activity logging.
API access
API key, OAuth, JWT, service account, token lifetime và rotation định kỳ.
Request signing
Xác minh HMAC, request time và giá trị duy nhất để replay protection.
Network access
Allowed IP address và domain, secure connection, VPN, network rule và tách test với production environment.
Role và permission
Permission của service và staff được cấp theo nguyên tắc least privilege.
Bảo vệ dữ liệu
Mã hóa, che giá trị nhạy cảm, retention period, xóa và quy tắc xử lý dữ liệu cá nhân.
Activity log
Request ID, actor, thời gian, thay đổi, lỗi và lịch sử giao dịch quan trọng.
Testing và nghiệm thu
Yêu cầu testing và nghiệm thu
Test environment phải tái hiện không chỉ giao dịch thành công mà cả lỗi, delay, retry, limit và reporting cuối.
Test environment
Endpoint riêng, access key, notification receiver, restriction và data reset rule.
Test data
Player, currency, payment method, provider, status và giá trị cho scenario có thể lặp lại.
Scenario thành công
Toàn bộ workflow từ request đầu tiên đến status cuối và việc phản ánh trong reporting.
Scenario lỗi
Dữ liệu không hợp lệ, timeout, giao dịch lặp lại, không đủ balance, bị từ chối và lỗi provider.
Log và diagnostics
Request ID, thời gian chính xác, status gốc và dữ liệu cần thiết để cùng điều tra.
Nghiệm thu
Danh sách scenario, kết quả dự kiến và owner chịu trách nhiệm sign-off đã được thống nhất.
Checklist sẵn sàng
Checklist tối thiểu trước khi bắt đầu development
Có thể bắt đầu lập kế hoạch tích hợp sau khi đã thống nhất phạm vi, quy tắc trao đổi dữ liệu, access, test environment và các bên chịu trách nhiệm.
Đã phê duyệt phạm vi tích hợp
Sản phẩm, market, system, function và launch stage đã được ghi nhận.
API documentation đã sẵn sàng
Endpoint, data format, status, lỗi, notification và example đã được mô tả.
Đã cấp test access
Key đang active, allowed IP address và notification endpoint đã được thống nhất.
Đã thống nhất security
Đã xác định authentication method, signing, role, key storage và logging.
Đã chuẩn bị test scenario
Có sẵn scenario thành công, lỗi, lặp lại và failure.
Đã chỉ định owner
Đã xác định owner phụ trách product, development, testing, security và support.
Cần review độ sẵn sàng của yêu cầu?
Cung cấp documentation, danh sách system, mô tả process và các environment hiện có. APIACE sẽ giúp xác định thông tin còn thiếu trước khi bắt đầu development.