API dự án tùy chọn
Hiển thị các chức năng ứng dụng đã thỏa thuận khi bạn cần chúng
Xem xét phạm vi API cho một dự án đủ điều kiện và phân biệt các tuyến đường được lên kế hoạch với các điểm cuối đã được xây dựng.
Xem API như một tùy chọn dự án được xác định trước.
- Xem lại tùy chọn
Kiểm tra tính khả dụng của API và gói dịch vụ tương ứng.
- Xác định phạm vi tuyến đường
Làm rõ các hoạt động kinh doanh mà API nên cung cấp.
- Xem danh mục tuyến đường
Xem phương thức, đường dẫn và trạng thái đã lên kế hoạch hoặc đang hoạt động của mỗi tuyến đường.
Thêm API khi dự án của bạn cần.
API của dự án là một phần tùy chọn của dịch vụ. Hãy xem xét phạm vi và điều khoản của nó trước khi kích hoạt, thay vì giả định rằng mọi ứng dụng đều bao gồm nó.
Các công cụ API sắp xếp các tuyến đường được đề xuất theo khu vực kinh doanh. Các giải thích giúp xác định rõ mỗi thao tác cần thực hiện trước khi triển khai.
Phân biệt các tuyến đường dự kiến với các điểm cuối đang hoạt động.
Chuẩn bị quyền truy cập cho hệ thống khác. Một dự án có thể cần một ứng dụng khác để sử dụng các hoạt động nghiệp vụ của nó. Hãy xem xét phạm vi API tùy chọn và đề xuất thay vì giả định rằng mọi chức năng đều tự động được cung cấp. Các hoạt động đã thỏa thuận xác định những gì tích hợp nên truy cập.
Kiểm tra danh mục tuyến đường. Danh mục hiển thị phương thức, đường dẫn, mô tả và trạng thái của từng tuyến. Nó giúp phân biệt phạm vi được đề xuất với các điểm cuối đã được đăng ký là hoạt động. Đây là tài liệu tham khảo hữu ích khi thực hiện các bước chuẩn bị cho API.
Chọn hướng tích hợp chính xác.. Sử dụng API của nhà cung cấp khác và cung cấp ứng dụng của riêng bạn là hai nhu cầu khác nhau. Kết nối bên ngoài đáp ứng nhu cầu trước; API dự án đáp ứng nhu cầu về việc cung cấp dịch vụ đã thỏa thuận. Hãy chọn phương án phù hợp với mục tiêu kinh doanh mà bạn muốn hướng tới.
Phân biệt API được công khai với kết nối bên ngoài.
API của dự án hiển thị các chức năng đã thỏa thuận của ứng dụng. Kết nối bên ngoài mô tả cách ứng dụng của bạn sử dụng một dịch vụ khác; chúng phục vụ các mục đích khác nhau.
Sử dụng danh mục tuyến đường để kiểm tra phương thức, đường dẫn và xem một điểm cuối có được lên kế hoạch hay đang hoạt động. Bản trình bày này không kích hoạt API cho dự án của bạn.
Đánh giá tùy chọn API dựa trên một nhu cầu cụ thể
Xác định ai sẽ sử dụng dữ liệu của dự án và tích hợp đó cần những thao tác nào. Điều này giúp phân biệt phạm vi API tùy chọn với một kết nối tới dịch vụ bên ngoài hiện có.
Với một dự án đủ điều kiện, hãy kiểm tra các tuyến đã lên kế hoạch và trạng thái xây dựng của chúng. Xác nhận dịch vụ và môi trường liên quan trước khi coi một endpoint là sẵn sàng cho tích hợp.
Từ phạm vi tùy chọn đến phạm vi hiển thị đã được xác minh
Kiểm tra tính khả dụng và điều kiện.. Kiểm tra tùy chọn API trong đề xuất dự án thực tế. Quyết định xem ứng dụng có cần tính năng này trước khi kích hoạt hay không.
Làm rõ các thao tác. Xem xét các hoạt động kinh doanh được đề xuất và trả lời các câu hỏi về hành vi dự kiến của chúng. Theo dõi các giai đoạn chuẩn bị và xây dựng.
Xem nội dung đang phát trực tiếp. Kiểm tra danh mục tuyến đường và tài liệu tham khảo đã xuất bản cho một dự án đang hoạt động. Một tuyến đường đã lên kế hoạch không phải là một điểm cuối hoạt động.
Xác định phạm vi tích hợp trước khi thêm API.
Giải thích các thao tác mà hệ thống khác cần và xem xét các điều kiện của tùy chọn. API nên phục vụ cho một thỏa thuận kinh doanh đã thống nhất.
Các câu hỏi về API của dự án tùy chọn.
Đây là một tùy chọn có giá và tính khả dụng được hiển thị trong thông tin sản phẩm. Ứng dụng có thể hoạt động mà không cần kích hoạt tùy chọn này. Trang này không cung cấp hoặc kích hoạt API cho dự án của bạn.
Nó mô tả một thao tác dự kiến chưa được đăng ký dưới dạng một điểm cuối hoạt động. Sử dụng trạng thái danh mục và tham chiếu đã xuất bản thực tế trước khi bắt đầu tích hợp.
Giao diện API của dự án hiển thị các lĩnh vực cần hiển thị, câu hỏi, cơ sở hạ tầng và trạng thái xây dựng. Giải quyết các điều kiện tiên quyết đã nêu và kiểm tra danh mục tuyến đường kết quả.
Sử dụng tài liệu tham khảo API thuộc về dự án và môi trường đã kích hoạt. Không lấy một điểm cuối hoặc ví dụ về xác thực chỉ từ một tuyến đường đã lên kế hoạch.
Họ mô tả một dịch vụ khác mà ứng dụng của bạn sử dụng. Hướng tích hợp đó khác với việc cung cấp các chức năng của ứng dụng của bạn thông qua API của dự án.