Nhiều lập trình viên hoặc một số nhà phát triển không biết cách kết nối với giao diện AG và BBIN. Trong bài viết này, họ đăng ký mở tài khoản cho giao diện AG và BBIN và kết nối với các giải pháp thành công dựa trên các tài liệu phát triển.
Về nguyên tắc, thiết kế giao diện API thường xảy ra trong thiết kế phát triển chi tiết, nhưng khi nhiều công ty thiết lập các nền tảng mở, các nhà quản lý sản phẩm cần có khả năng hiểu các giao diện API, đặc biệt là đối với các sản phẩm dựa trên nền tảng và học cách xác định giao diện. Bài viết này giải thích những gì các nhà quản lý sản phẩm cần xác định và chú ý trong giao diện thiết kế.
1. Hiểu kiến thức cơ bản
Khi thiết kế giao diện, nếu bạn là người mới, nên tham khảo và hiểu các kiểu giao diện của các nền tảng mở khác nhau, chẳng hạn như Baidu, Google, Tencent, v.v. và bạn có thể tìm thấy một số sự đồng thuận từ chúng;
1. Các giao thức truyền thông thường được sử dụng
Gọi các giao diện nền tảng của bên thứ ba yêu cầu giao tiếp giữa các hệ thống. Hiện tại, các giao thức thường được sử dụng là HTTP và HTTPS; Chỉ cần hiểu rằng HTTPS là phiên bản HTTP được mã hóa, có thể mã hóa thông tin được người dùng yêu cầu đến máy chủ để tránh lấy thông tin người dùng do chặn truyền văn bản đơn giản.
Các giao diện dựa trên giao thức HTTP là nhẹ, đa nền tảng và ngôn ngữ chéo. Để thích ứng với các nhà phát triển khác nhau, mỗi nền tảng của bên thứ ba hiện cung cấp các biểu mẫu giao diện dựa trên các ngôn ngữ phổ biến khác nhau, do đó, hầu hết họ sử dụng giao thức HTTP hoặc HTTPS; Ví dụ, Baidu, Iflytek: Tác giả đã kiểm tra các nền tảng đám mây của Baidu, Google, Tencent và Alibaba và thấy rằng giao thức HTTPS được sử dụng theo tầm nhìn; Đối với tầm nhìn, bản thân dữ liệu hình ảnh chứa rất nhiều thông tin, đặc biệt là khuôn mặt, vì vậy sử dụng HTTPS vẫn có lợi để bảo vệ thông tin bảo mật của người dùng.
2. Phương thức yêu cầu giao diện
Hiểu phương thức yêu cầu của giao diện giúp hiểu sự tương tác giữa người dùng và máy chủ. Các phương thức yêu cầu thường được sử dụng dựa trên giao thức HTTP là POST và GET; Sự khác biệt chính giữa hai người như sau:
. Tác động trực tiếp là các tham số yêu cầu của GET có giới hạn độ dài và bài đăng là không giới hạn; Thứ hai, bảo mật của việc đưa các tham số vào URL yếu hơn POST;
(2) Sự khác biệt chuyên sâu: Người dùng và máy chủ chỉ có một tương tác và người dùng sẽ có hai tương tác với máy chủ. Ví dụ: Chuyển phát nhanh là người dùng và bạn là máy chủ. Sau đó, nhận được giống như một chuyển phát nhanh thường đến với cộng đồng của bạn và người chuyển phát nhanh mà bạn biết trực tiếp cung cấp giao hàng nhanh đến nhà bạn. Bạn nói lời cảm ơn đến anh ấy; Bài đăng giống như một chuyển phát nhanh mới gọi bạn trước và hỏi bạn có ở nhà không? Bạn nói với anh ấy rằng bạn đang ở nhà. Sau 5 phút, anh ấy sẽ giao hàng nhanh đến nhà bạn. Bạn nói lời cảm ơn đến anh ấy;
Hiện tại, các giao diện nhận dạng hình ảnh của Baidu, Tencent và Megvii đều sử dụng phương thức yêu cầu POST.
3. Cơ chế đáp ứng giao diện
Cuối cùng, hiểu cơ chế phản hồi của giao diện: giao diện đồng bộ và giao diện không đồng bộ; Chỉ cần hiểu giao diện đồng bộ trả lại tin nhắn cho người gọi trong thời gian thực và giao diện không đồng bộ có thể trì hoãn các tin nhắn trả về cho người gọi; Những người có yêu cầu thời gian thực cao và chỉ có thể hoạt động tuyến tính cần sử dụng các giao diện đồng bộ và các giao diện không đồng bộ khác có thể được ưu tiên; Tất nhiên, trong các kịch bản khác nhau, cùng một giao diện dịch vụ sẽ được yêu cầu phải đồng bộ hoặc không đồng bộ; Lấy đăng ký khuôn mặt trong nhận dạng khuôn mặt làm ví dụ:
(1) Thanh toán quét mặt: Lấy Alipay làm ví dụ. Trước khi sử dụng nó, bạn cần thu thập khuôn mặt theo các bước. Bối cảnh sẽ gọi đăng ký khuôn mặt để đăng ký mặt hiện tại vào thư viện khuôn mặt và liên kết nó với thông tin tài khoản Alipay. Bước đăng ký khuôn mặt này thường là giao diện đồng bộ vì người dùng sẽ không được yêu cầu phải chờ quá lâu trước ứng dụng và thông tin thành công đăng ký cần được trả về kịp thời;
. Trong số đó, những khuôn mặt kỳ lạ được công nhận lần đầu tiên thường cần được đăng ký vào thư viện khuôn mặt kỳ lạ. Đăng ký khuôn mặt ở đây nói chung là một giao diện không đồng bộ. Bởi vì các siêu thị lớn có hàng trăm ngàn dòng hành khách mỗi ngày và không có thông tin thành viên cho người lạ, nên không cần phải đăng ký theo thời gian thực. Miễn là bạn vào hàng đợi, bạn có thể đăng ký trong vòng 24 giờ trong cùng một ngày;
bản tóm tắt
Ý thức chung ở trên về giao diện API. Khi thiết kế giao diện, sự phát triển thường yêu cầu sản phẩm xác định cơ chế phản hồi của giao diện; Những phát triển khác sẽ được hoàn thành bởi chính họ; Nhưng là một nền tảng mở, các sản phẩm thường kết nối với sự phát triển. Tìm hiểu ý thức chung hơn không chỉ có thể giao tiếp với sự phát triển của riêng bạn bằng ngôn ngữ chung, mà còn giải thích ngắn gọn cho người dùng khi kết nối với người dùng.
2. Các trường kinh doanh cốt lõi & các ràng buộc giao diện
Mặc dù các nhà quản lý sản phẩm không cần xác định tất cả thông tin hiện trường trong API, các nhà quản lý sản phẩm cần phải rõ ràng và rõ ràng về các lĩnh vực liên quan đến nhu cầu kinh doanh.
1. Nhập nhân sâm
(1) Thông tin trường xác thực
Gọi các giao diện nền tảng của bên thứ ba thường yêu cầu xác thực giao diện và máy chủ xác định xem người dùng có quyền gọi giao diện hay không; Điều liên quan đến người quản lý sản phẩm ở đây là với tư cách là một sản phẩm, nó yêu cầu quản lý thiết kế và ứng dụng, bao gồm: danh sách ứng dụng, tạo ứng dụng, chi tiết ứng dụng, cấu hình ứng dụng, xóa ứng dụng và các hoạt động khác; Với nền tảng Baidu AI, danh sách ứng dụng như sau:
Trong số đó, API_account (tài khoản API), SIGN_KEY (khóa API) và mã (chữ ký được mã hóa) về cơ bản được tạo tự động khi tạo một ứng dụng. Phải có được access_token để xác thực giao diện phải được lấy thông qua khóa API và máy chủ yêu cầu khóa bí mật.
(2) Các lĩnh vực kinh doanh cốt lõi
Các nhà quản lý sản phẩm cần làm rõ thông tin lĩnh vực nào là cần thiết trong các tham số giao diện và các loại trường được hỗ trợ bởi các nhà quản lý sản phẩm theo nhu cầu kinh doanh của họ. Lấy nhận dạng món ăn của nền tảng Baidu AI làm ví dụ:
Yêu cầu kinh doanh: Xác định món ăn nào trong hình;
Yêu cầu sản phẩm:
Nhập hình ảnh, hỗ trợ hình ảnh thường là định dạng Base64 và URL;
TOP_NUM cải thiện tính phổ quát của giao diện và tạo điều kiện cho người dùng mở rộng các tình huống tiếp theo, do đó, nó hỗ trợ cấu hình để trả về số lượng món ăn và sắp xếp chúng;
Ngưỡng, ngưỡng nhận dạng mở, tạo điều kiện cho người dùng điều chỉnh theo hiệu ứng nhận dạng thực tế và cải thiện độ chính xác;
Lưu ý: Khi thiết kế các trường kinh doanh cốt lõi của giao diện, chúng ta phải cố gắng cải thiện tính phổ quát của giao diện, để thích ứng với nhiều kịch bản người dùng hơn, chẳng hạn như mở top_num và ngưỡng, nghĩa là khái quát hóa khả năng giao diện và đưa ra nhiều sáng kiến hơn để cấu hình giao diện.
(3) Hạn chế thông tin thực địa
Các ràng buộc trường là để đảm bảo bảo mật của giao diện. Điều này được cung cấp cho đối tác phát triển sau khi người quản lý sản phẩm giao tiếp với bên kinh doanh; Các món ăn trên vẫn được công nhận là một ví dụ:
Hình ảnh cần giới hạn kích thước tệp và kích thước độ phân giải. Kích thước tệp chỉ cần một giới hạn trên. Kích thước độ phân giải cần bao gồm giới hạn trên và giới hạn dưới. Giới hạn thấp hơn là đảm bảo hiệu ứng của thuật toán. Ví dụ, các mục tiêu nhỏ dễ bị thất bại trong phát hiện mục tiêu;
TOP_NUM cần giới hạn giới hạn thấp hơn, không nhỏ hơn 0, không có giới hạn trên được đặt và tất cả các kết quả được trả về bởi thuật toán có thể được chấp nhận;
Giá trị ngưỡng được xác định theo định dạng, có thể là 0-100 và có thể là 0-1;
Lưu ý: Một mẹo nhỏ để đặt tham số. Để đảm bảo hiệu ứng của thuật toán, đôi khi thuật toán sẽ đặt tham số theo mặc định, nghĩa là ngưỡng được đặt bởi người dùng thấp hơn các tham số mặc định và đầu vào không được chấp nhận. Mặc định được sử dụng và người dùng không biết;
2. Trích xuất nhân sâm
Khi gọi giao diện, sẽ có thông tin được trả lại. Sản phẩm cần xác định thông tin lĩnh vực cốt lõi được trả lại dựa trên nhu cầu kinh doanh. Lần này, lấy nhận dạng cử chỉ nền tảng mở của Baidu AI làm ví dụ, các trường chính liên quan đến nhu cầu kinh doanh bao gồm:
result_num, kết quả, nghĩa là số lượng kết quả cử chỉ được ghi nhận trong một hình ảnh và thông tin cử chỉ cụ thể;
Kết quả là một mảng JSON, bao gồm danh mục cử chỉ, thông tin vị trí của hộp phát hiện cử chỉ [lớp dưới cùng của thuật toán nhận dạng chung là phát hiện + nhận biết hai bước] và mức độ tin cậy của danh mục cử chỉ;
Trong số đó, một số thông tin hiện trường trong kết quả có thể được thêm và giảm theo nhu cầu kinh doanh, chẳng hạn như thông tin vị trí của hộp phát hiện mục tiêu, có thể được bỏ qua nếu doanh nghiệp không cần nó;
3. Giao diện giới hạn hiện tại
Giới hạn hiện tại của giao diện cũng là để đảm bảo tính bảo mật của hệ thống, bởi vì đôi khi khối lượng cuộc gọi của bên kinh doanh tăng do mở rộng kinh doanh, có thể dễ dàng khiến máy chủ giảm xuống; Giới hạn hiện tại tương tự như cầu chì của công tắc để đảm bảo rằng hệ thống có thể từ chối yêu cầu hoặc hàng đợi khi số lượng yêu cầu vượt quá giới hạn trên của giao diện, do đó đảm bảo bảo mật của hệ thống;
Các nhà quản lý sản phẩm cần đánh giá đầy đủ doanh nghiệp và đưa ra số tiền đánh giá hợp lý, chẳng hạn như TPS (yêu cầu được xử lý mỗi giây); Điều này sẽ không gây lãng phí tài nguyên hệ thống, nhưng cũng đảm bảo hoạt động bình thường của doanh nghiệp;
Lưu ý: Tương ứng với cơ chế phản hồi giao diện trên, giao diện đồng bộ thường cần cung cấp cho TPS và thời gian phản hồi cực đại và giao diện không đồng bộ cần phải điều chỉnh hàng ngày;
4. Kiểm tra giao diện
Mặc dù kiểm tra giao diện là công việc của một cô gái kiểm tra, nội dung thử nghiệm bao gồm rất nhiều, như một sản phẩm, bạn có thể hiểu đơn giản các nội dung sau, chẳng hạn như
.
(2) Bảo hiểm yêu cầu kinh doanh, nghĩa là, liệu đầu vào giao diện và đầu ra có tuân thủ mô tả tài liệu yêu cầu sản phẩm hay không;
(3) các quy tắc ranh giới tuân theo, nghĩa là, liệu giao diện có đáp ứng các quy tắc kinh doanh và các ràng buộc thực địa hay không;
(4) Điều kiện hiệu suất. Thông thường, trước khi giao diện được ra mắt, nó phải được kiểm tra để đáp ứng các chỉ số hiệu suất, bao gồm TPS và tốn thời gian theo một số tiền đồng thời nhất định;
Kết nối chính thức bắt đầu
1. Trước hết, chúng ta cần đăng ký giao diện API. Ở đây tôi sẽ cho bạn biết cách áp dụng.
(1) Có thể được thông qua trực tiếpPhương pháp ứng dụng tự phục vụ mở tài khoản trực tuyến, Hình ảnh sau nếu bạn chỉ muốn kết nối với giao diện AG, bạn có thể chọn đăng ký với một hạn ngạch giao diện duy nhất. Mặt khác, nếu bạn muốn kết nối với nhiều nền tảng trò chơi, bạn có thể chọn đăng ký với một thương nhân hạn ngạch chung. Nếu bạn muốn mở rộng thị trường ở nước ngoài, khách hàng bên ngoài đại lục có thể áp dụng để hỗ trợ chuyển đổi tự động tỷ giá đa tiền tệ đa ngôn ngữ.Giao diện API quốc tế Ngôn ngữ và tiền tệ được hỗ trợ như sau
[Trung Quốc] [truyền thống] [Tiếng Việt] [Tiếng Anh] và gia đình ngôn ngữ tương ứng (tiền tệ)
- Một dòng chỉ hỗ trợ một tiền tệ
- Tất cả tiền tệ:
Comment
(RMB)Language
Vâng.VNDStencils
(vnd)ĐÈ
(USD) - Tất cả ngôn ngữ:
CN
(Hoa)Không.
(Trung Hoa truyền thống)th
(Thái)chúng
(Việt)Một
(Tiếng Anh) - Lưu ý ở đây rằng có một sự khác biệt giữa giao diện phiên bản quốc tế và giao diện không phải là phiên bản quốc tế và các tài liệu phát triển cũng khác nhau. Những người truy cập phiên bản quốc tế có thể trực tiếp bỏ qua nơi này.

(2) Sau khi đăng nhập thành công, bạn có thể kiểm tra Apikey của mình
Với tài khoản API và khóa, bạn cần thêm IP của máy chủ của riêng mình để liên kết với tài khoản của bạn. Đây cũng là một loại xác thực bảo mật. Ngay cả khi tài khoản API và khóa API của bạn bị đánh cắp hoặc bị rò rỉ, những người khác không thể vận hành tài khoản của họ thông qua API. Bước này cũng là cần thiết. Nếu không có tài liệu tham khảoThiết lập giao diện cho danh sách trắng
(3) Hãy để theo dõi giao diện mớiTài liệu phát triểnĐể cập cảng,


. Tôi đã điền vào các trường cần thiết theo các tham số cần thiết của tài liệu.

(5) Từ bây giờ, bạn có thể thấy rằng một tài khoản AG đã được đăng ký thành công thông qua hình bên dưới.

Sau đó, sự phát triển và gỡ lỗi tiếp theo có thể được thực hiện thông qua các tài liệu. Phương thức truy cập giao diện BBIN và các phương thức truy cập giao diện khác về cơ bản là giống nhau. Phụ thuộc vào nhu cầu của bạn cụ thể.
Bài viết này chủ yếu bao gồmCách kết nối với AG, giao diện BBIN Áp dụng cho việc mở tài khoản cho giao diện AG và BBINThìGiao diện BBINPhương thức truy cập