Một plan (gói) là tập hợp các tài nguyên API hoặc các phần (subset) của tài nguyên từ một hoặc nhiều API. Một gói có thể bao gồm nhiều loại thao tác khác nhau thuộc các API khác nhau. Một gói có thể có giới hạn tần suất truy cập chung áp dụng cho tất cả tài nguyên, hoặc mỗi tài nguyên có thể có giới hạn riêng. Rate limit là giới hạn cho biết một ứng dụng được phép gửi tối đa bao nhiêu yêu cầu trong một khoảng thời gian nhất định.

Hãy sử dụng PvcomBank’s Open Banking Portal này để xem các gói API khác nhau đang được cung cấp và chọn gói phù hợp nhất với nhu cầu của bạn. Một số gói có quyền truy cập hạn chế và Quý khách sẽ cần gửi yêu cầu để được cấp quyền sử dụng. Khi Quý khách gửi yêu cầu, tổ chức sẽ nhận được thông báo, quản trị viên API sẽ xem xét và có thể liên hệ với Quý khách để trao đổi thêm thông tin. Những gói khác thì có thể sử dụng ngay lập tức mà không cần phê duyệt.

Số lượng yêu cầu (requests) mà ứng dụng của Quý khách đã thực hiện đối với từng API sẽ được hiển thị tại trang quản lý ứng dụng.

Quý khách vui lòng chọn mục “Apps” trên thanh menu và lựa chọn ứng dụng tương ứng. Tại bảng “Product Subscriptions”, Quý khách có thể theo dõi toàn bộ các gói (plan) mà ứng dụng đã đăng ký sử dụng.

Đối với từng API thuộc gói đó, hệ thống sẽ hiển thị mức độ sử dụng hiện tại so với giới hạn truy cập (rate limit) quy định của gói dịch vụ.

Quý khách có thể thực hiện kiểm thử API trực tiếp trên Cổng thông tin dành cho Nhà phát triển (Developer Portal).

Tại trang thông tin chi tiết của từng API, hệ thống sẽ hiển thị danh sách các thao tác (operations) tương ứng. Danh sách này bao gồm phương thức (verb) và đường dẫn (path) được sử dụng cho từng thao tác.

Khi lựa chọn một thao tác cụ thể, Quý khách có thể xem thêm các thông tin chi tiết bao gồm tham số đầu vào, dữ liệu trả về, các mã phản hồi (return codes) và ý nghĩa của từng mã.

Đối với các API REST, hệ thống cung cấp nút “Try” cho phép Quý khách thực hiện kiểm thử trực tiếp ngay trên Developer Portal.

Trong trường hợp API yêu cầu khai báo Client ID hoặc Client Secret để xác thực, Quý khách vui lòng sử dụng thông tin định danh của ứng dụng tại khu vực cấu hình phía trên mục “Try”.

Khi Quý khách tạo mới một ứng dụng, hệ thống sẽ cung cấp API Key và API Secret tương ứng. Quý khách cần sử dụng các thông tin này khi thực hiện gọi tới những API yêu cầu xác thực ứng dụng.

Để đăng ký ứng dụng, vui lòng chọn mục “Apps” trên thanh menu chính, sau đó lựa chọn liên kết “Create new app”. Sau khi cung cấp tên ứng dụng, mô tả và các thông tin cần thiết khác, hệ thống sẽ hiển thị API Key và API Secret dành cho ứng dụng của Quý khách.

Lưu ý: Quý khách vui lòng ghi lại API Secret, vì thông tin này chỉ được hiển thị một lần duy nhất.

API Secret của Quý khách được lưu trữ dưới dạng mã hóa, do vậy chúng tôi không thể truy xuất và cung cấp lại giá trị ban đầu nếu Quý khách quên thông tin này.

Tuy nhiên, Quý khách có thể thực hiện đặt lại API Secret. Khi thực hiện thao tác này, hệ thống sẽ cập nhật giá trị mới và hiển thị API Secret mới cho Quý khách.

Để đặt lại API Secret, vui lòng chọn mục “Apps” trên thanh menu, sau đó chọn ứng dụng cần thực hiện và nhấn vào liên kết “Reset” tại mục “API Secret”.

API Secret mới sẽ được hệ thống hiển thị tại phần phía trên của trang.