Khi có nhu cầu tích hợp với BIDV qua Open API, quý khách vui lòng đăng nhập, chọn 'Đăng ký tích hợp', nhập thông tin và gửi đăng ký. Sau khi nhận được yêu cầu tích hợp, BIDV sẽ liên hệ và hướng dẫn quý khách thực hiện quy trình tích hợp.

Khi bạn thêm một ứng dụng, bạn sẽ được cung cấp API Key và Secret cho ứng dụng đó. Bạn phải cung cấp các thông tin xác thực này khi bạn gọi một API yêu cầu bạn xác thực ứng dụng của mình. Để đăng ký một ứng dụng, hãy nhấp vào App trong menu chính và sau đó nhấp vào liên kết 'Tạo một app mới'. Khi bạn đã cung cấp tên ứng dụng, mô tả, v.v., bạn sẽ được hiển thị API Key và Secret của ứng dụng. Ghi lại API Secret của bạn vì nó chỉ được hiển thị một lần.

API Secret của bạn được lưu trữ mã hóa nên chúng tôi không thể truy xuất phiên bản không được mã hóa trong trường hợp bạn quên nó. Bạn có thể đặt lại nó, thao tác này sẽ cập nhật giá trị được lưu trữ và trả lại giá trị mới cho bạn. Để đặt lại API secret, nhấp vào ứng dụng trong menu chính, nhấp vào ứng dụng cần đặt lại secret và sau đó bạn có thể nhấp vào 'Đặt lại' trong phần 'API Secret'. Secret mới của bạn sẽ được hiển thị ở đầu trang.

Plan là tập hợp (hoặc tập hợp con) các tài nguyên dùng cho một hoặc nhiều API. Một plan có thể quy định các cách hoạt động riêng cho các API khác nhau. Một plan cũng quy định giới hạn tần suất cuộc gọi API chung cho tất cả tài nguyên, hoặc mỗi tài nguyên có giới hạn tần suất cuộc gọi riêng. Giới hạn tần suất cuộc gọi cho biết số lượng cuộc gọi API tối đa mà mỗi ứng dụng được phép thực hiện trong một khoảng thời gian nhất định. Trang Developer Portal này cho phép lựa chọn các plan phù hợp với yêu cầu của người dùng. Một số plan bị giới hạn truy cập và cần yêu cầu truy cập để sử dụng. Khi bạn gửi yêu cầu, tổ chức sẽ được thông báo, quản trị viên API sẽ đánh giá yêu cầu của bạn và họ có thể liên hệ với bạn để biết thêm chi tiết. Các plan còn lại có thể sử dụng được luôn.

Tổng số lượng cuộc gọi API cho từng app được hiển thị trên trang ứng dụng của bạn. Chọn “Ứng dụng” trên thanh menu và chọn ứng dụng của bạn. Chọn thẻ “Đăng kí”, bạn có thể thấy tất cả các plan mà ứng dụng của bạn đã đăng kí. Với từng API trong plan, bạn có thể thấy mức sử dụng so với giới hạn tần suất cuộc gọi của plan đó.

Khi xem chi tiết một API, bạn sẽ thấy giao thức và đường dẫn để sử dụng cho API đó. Nếu bạn nhấp vào API, bạn sẽ thấy thêm thông tin về nó, ví dụ: những thông số mà API cần, những gì API trả về, những đoạn code trả ra mà API có thể sử dụng và ý nghĩa của chúng. Ngoài ra còn có nút 'Try' trên các API REST cho phép bạn thử thao tác trực tiếp từ Developer Portal. Nếu API yêu cầu client ID hoặc client secret để nhận dạng thì bạn có thể khai báo các mã này bằng thông tin đăng nhập ứng dụng của mình ở đầu phần 'Try'.