Liệt kê các dịch vụ
Gọi endpoint tìm kiếm dịch vụ mà không có cụm từ tìm kiếm.Lấy mọi trang
- Kích thước trang mặc định là 50. Giá trị tối đa là 100.
- Gửi một request GET đến URL
next. Tiếp tục cho đến khi response không có trườngnext. - Một URL
nexttương đối được phân giải theohttps://api.inflowpay.ai. - Coi URL
nextlà một giá trị opaque. Không tự tạo URL này và không thay đổi cursor của URL.
Liệt kê các dịch vụ bằng SDK Node
https://directory.offeringprotocol.org, và bạn không thể thay đổi URL này. Với sandbox, dùng createDirectoryClient({ environment: "sandbox" }).
Các trường mà SDK bỏ qua
SDK directory bỏ qua các trường sau của tài liệu dịch vụ, vì parser của SDK không kiểm tra tính hợp lệ của các trường này.branding, mcp, http, odp_version, payment_origins, search_capabilities
Để lấy một trong các trường này, gọi trực tiếp API, hoặc đọc Service Document hiện tại của dịch vụ.
SDK cho các ngôn ngữ khác
Mỗi SDK của ODP có hỗ trợ directory. Tên phương thức và các API lặp khác nhau theo ngôn ngữ. Mỗi repository có tài liệu về directory client của mình.Đồng bộ một bản sao cục bộ
Với một directory nhỏ, dùng cách này.1
Lấy toàn bộ danh sách theo lịch
Đọc mọi trang của danh sách theo một khoảng thời gian đều đặn.
2
Dùng origin làm khóa cho mỗi mục
Lưu hoặc cập nhật mỗi mục với
service_origin làm khóa.3
Chỉ thay bản sao cũ sau khi đọc đầy đủ
Chỉ thay bản sao trước đó khi mọi trang tải xong và không có mục nào bị từ chối. Chỉ khi đó mới xóa các mục không có trong danh sách mới.
4
Giữ bản sao cũ khi có lỗi
Nếu một request thất bại, giữ bản sao trước đó.
Đọc danh mục của một dịch vụ
Mục trong directory là metadata khám phá đã lưu cache. Để đọc danh mục hiện tại, kết nối với dịch vụ tạiservice_origin của dịch vụ đó bằng SDK agent của ODP.
Nếu
getOffering không phân giải được các thuộc tính, đọc issues mà lời gọi trả về. Không giả định rằng offering không có thuộc tính.
Chỉ dùng các operation mà dịch vụ công bố
Một dịch vụ không cólist-offerings và get-offering không phải là một dịch vụ có danh mục rỗng. Một số dịch vụ dùng tìm kiếm hoặc collection thay thế. Kiểm tra các operation mà dịch vụ công bố. Sau đó, dùng searchOfferings(), listCollections() hoặc listCollectionOfferings(collectionId) theo hỗ trợ của dịch vụ.
Danh mục có thể cần xác thực hoặc thanh toán
Directory API là công khai, nhưng các operation danh mục của một dịch vụ có thể cần xác thực hoặc thanh toán. Trước khi bạn đọc một danh mục, kiểm tra giá trịauthentication của mỗi operation và các giao thức thanh toán mà dịch vụ công bố. Truy cập có xác thực hoặc có trả phí cần code riêng.
Các lời gọi này chỉ đọc dữ liệu. Các lời gọi này không gọi các hành động của một offering và không mua gì cả.
SDK agent cũng hỗ trợ xác thực, phân trang, caching và phân giải hành động. Xem thư mục packages/agent trong offering-protocol/odp-node.
Trang liên quan
Directory của InFlow
Đọc những gì một listing hiển thị và tìm kiếm trong directory bằng CLI.
Cách Discover hoạt động
Đọc cách các dịch vụ, collection, offering và hành động kết hợp với nhau.