Cách truyền đạt hiệu quả các thay đổi API thông qua tự động hóa

Cho dù là API Trải nghiệm, Quy trình hay Hệ thống, giao diện lập trình ứng dụng là nền tảng để tạo ứng dụng. API cho phép các tổ chức trở nên linh hoạt để đạt được các mục tiêu kinh doanh, kỹ thuật và tổ chức của họ.

Giao tiếp và tự động hóa quy trình thông báo API để thông báo cho các bên liên quan rằng có API mới hoặc API đã thay đổi cho phép các bên liên quan tận dụng các cơ hội để họ có thể tập trung vào việc tạo các quy trình hoặc tạo ra các luồng doanh thu mới. Ngoài ra, tự động hóa hạn chế rủi ro từ lỗi của con người, tiết kiệm thời gian thực hiện các nhiệm vụ lặp đi lặp lại và cho phép các thành viên trong nhóm tập trung vào các hoạt động khác.

Sử dụng tự động hóa để truyền đạt các thay đổi API

Báo cáo Chuẩn Đối Sánh Kết Nối của MuleSoft cho thấy 90% tổ chức có chiến lược API và tích hợp rõ ràng, đồng thời hơn một phần tư số người được hỏi cho biết các nhà lãnh đạo hiện yêu cầu tất cả các dự án tuân thủ chiến lược tích hợp API trên toàn công ty.

Với quan điểm này, làm thế nào chúng ta có thể hỗ trợ quản lý, phát triển và giao tiếp trong hệ sinh thái API? Hai giải pháp hiện lên Đầu tiên, chúng ta có thể sử dụng MuleSoft Universal API Manager để đóng vai trò là nguồn trung tâm để quản lý và điều chỉnh bất kỳ loại API nào. Điểm mấu chốt thứ hai của bài viết này là cách truyền đạt hiệu quả các thay đổi API tới các bên liên quan trong hệ sinh thái API.

4 bước để truyền đạt các thay đổi API

API là kết cấu của sự phát triển ứng dụng. Với sự đổi mới và cải tiến liên tục, các API mới sẽ được tạo, khấu hao hoặc thay đổi. Để truyền đạt hiệu quả những thay đổi API này, bạn cần tuân theo và hiểu bốn bước sau:

1. Biết đối tượng API của bạn
2. Thiết lập các kênh liên lạc của bạn
3. Xác định loại thay đổi API
4. Xác định nội dung thông báo

1. Biết đối tượng API của bạn

Chìa khóa để truyền đạt các thay đổi API là biết đối tượng của bạn. Đối tượng của bạn là “Ai?” có thể bị ảnh hưởng bởi một API mới hoặc đã thay đổi. Điều này có thể bao gồm từ các bên liên quan trong nội bộ của tổ chức như nhà phát triển, quản lý và giám đốc điều hành hoặc người sử dụng API.

Người sử dụng API có thể là đối tác kinh doanh hoặc nhà đổi mới nền tảng. Các đối tác kinh doanh có thể tích hợp ứng dụng của họ với nền tảng của tổ chức bạn. Các nhà đổi mới sử dụng API để tạo các cơ hội kinh doanh độc đáo nhằm mở ra các luồng doanh thu mới.

Việc biết đối tượng API của bạn sẽ đặt nền móng cho việc thông báo các thay đổi về API. Đối tượng nào là đầu mối liên hệ để gửi thông báo khi xảy ra thay đổi API hoặc tạo API mới.

2. Thiết lập (các) kênh liên lạc của bạn

Kênh liên lạc thông báo cho người dùng rằng một API đã thay đổi hoặc có sự bổ sung. Kênh liên lạc cung cấp nội dung API phù hợp với mục đích (ví dụ: tên, mô tả, vị trí). Nó cũng cung cấp sự hỗ trợ cho giao tiếp chủ động và thụ động. Thông báo chủ động xảy ra khi thay đổi API tác động đến các ứng dụng hiện có. Người tiêu dùng API sẽ cần hành động theo sự kiện để ứng dụng của họ không bị lỗi. Thông báo thụ động không cần phản hồi ngay lập tức và chứa nhiều thông tin hơn.

Để đạt được các mục tiêu của kênh truyền thông, có ba cách tiếp cận để sử dụng. Thứ nhất, áp dụng nền tảng tích hợp, thứ hai, sử dụng phần mềm cổng thông tin và thứ ba, viết mã. Ba cách tiếp cận cho phép thông báo người dùng, gửi tin nhắn cũng như truy cập tài liệu API.

Nền tảng cộng tác cho phép giao tiếp giữa các đối tượng (ví dụ: nhà phát triển, người sử dụng API, quản lý). Nền tảng cộng tác cũng cho phép người dùng làm việc cùng nhau. Slack là một ví dụ tốt về điều này. Slack tạo điều kiện tương tác với người dùng theo thời gian gian thực và nhúng quy trình làm việc tự động.

Phần mềm cổng thông tin đóng vai trò là nền tảng trung tâm để khán giả tập hợp thành một cộng đồng và truy cập thông tin – trong trường hợp này là về các chi tiết API mới hoặc đã thay đổi. Anypoint Community Manager cung cấp khả năng này và phục vụ như một cổng thông tin cho các thành viên cộng đồng API. Nó cũng có thể tự động điền tài liệu API từ Anypoint Exchange.

Cuối cùng, mã trong ứng dụng của bạn có thể hỗ trợ truyền đạt các thay đổi API. Các nhà phát triển có thể viết các tiêu đề cảnh báo trong API hoặc gọi một dịch vụ chung để kiểm tra trạng thái API. Ngoài ra, có thể gửi thông báo qua email về các sự kiện thay đổi API sắp tới. Thành viên sẽ được thông báo rằng API sẽ thay đổi hoặc không được dùng nữa. Sử dụng các phương pháp này cùng với tự động hóa sẽ cải thiện giao tiếp và nâng cao trải nghiệm của khán giả.

3. Xác định loại thay đổi API

Một số yếu tố có thể tồn tại để thay đổi API xảy ra. Khả năng kinh doanh mới, thay đổi quy trình hoặc cải tiến kiến trúc và thiết kế gây ra thay đổi API. Những thay đổi API này có thể được phân loại là vi phạm hoặc không vi phạm.

• Các thay đổi lớn là các sửa đổi API khiến ứng dụng bị lỗi. Chúng có thể tàn phá môi trường của bạn. Một số ví dụ về các thay đổi vi phạm API là thêm các tham số truy vấn bắt buộc, thay đổi định dạng dữ liệu hoặc đổi tên tài nguyên API.
• Những thay đổi không vi phạm sẽ không ảnh hưởng đến người dùng API và chứa đựng nhiều thông tin hơn. Các thay đổi không phá vỡ đã tạo thêm thao tác mới, thêm thuộc tính dữ liệu tùy chọn hoặc tham số truy vấn tùy chọn.

Cung cấp khả năng hiển thị ngay lập tức cho người dùng của bạn khi xác định các thay đổi API là chìa khóa. Điều này sẽ cho phép người dùng phản ứng và đáp ứng với sự thay đổi. Nó sẽ giảm rủi ro khi triển khai API. Ngoài ra, nó củng cố niềm tin của người dùng. Người xem biết rằng có một quy trình thông báo cho họ về những thay đổi và tác động tiềm ẩn đối với các ứng dụng của họ.

4. Xác định nội dung thông báo

Làm cho thông báo thông báo API trở nên dễ hiểu đối với người xem. Để làm điều này, hãy phân loại đối tượng và xác định nội dung cần thiết. Nội dung phải cần thiết, phù hợp và hữu ích. Gặp gỡ với từng kiểu đối tượng nhân viên và nhận được các yêu cầu quan trọng cụ thể. Hãy nhớ rằng, truyền tải đúng thông báo vào đúng thời điểm là rất quan trọng. Điều này sẽ ngăn chặn tình trạng quá tải thông tin và tránh nhầm lẫn. Người dùng của bạn sẽ biết thông điệp được gửi là có liên quan.

Để mọi thứ vào cùng một nơi

Bây giờ bạn đã có hình ảnh về bốn bước được xác định để truyền đạt các thay đổi API, hãy tóm tắt lại các công nghệ sẽ sử dụng:

• Slack: Sử dụng Slack để cộng tác, giao tiếp và tự động hóa quy trình làm việc của nhân viên.
• MuleSoft Anypoint Community Manager: Đây sẽ là cổng thông tin của bạn. Bạn có thể xây dựng cộng đồng xung quanh API của mình và trình bày tài liệu API cho người xem.
• MuleSoft Anypoint Exchange: Anypoint Exchange chứa một danh mục được quản lý về API và thông tin liên quan đến API. Thông tin từ Exchange được tự động điền vào Anypoint Community Manager. Nhúng cảnh báo trong API của bạn để thông báo cho người xem về những thay đổi.

Việc tích hợp và tự động hóa các sản phẩm này sẽ cung cấp một giải pháp linh hoạt để truyền đạt các thay đổi của API và đưa bạn đến con đường xây dựng lòng tin với nhân viên của mình cũng như giảm thiểu rủi ro trong hệ sinh thái API.