API là viết tắt của Giao diện lập trình ứng dụng. Bất kỳ phần mềm nào có chức năng cụ thể đều được gọi là ứng dụng khi thảo luận về API. Bạn có thể so sánh giao diện API với thỏa thuận dịch vụ giữa hai chương trình chỉ định yêu cầu và phản hồi. Nếu bạn chưa quen với API, chúng tôi khuyên bạn nên xem qua Hướng dẫn cho người mới bắt đầu về API và Tổng quan về API REST blog trước khi đọc cái này.
API REST cho phép bạn truy cập dữ liệu CRM thông qua giao thức HTTP/HTTPS. Bạn có thể thực hiện các hành động như tạo, cập nhật, truy xuất hoặc xóa các hoạt động trên bất kỳ thông tin bản ghi CRM nào. Nó cũng sẽ cho phép bạn lưu trữ dữ liệu cấu hình dành riêng cho tiện ích mở rộng và dành riêng cho người dùng hoặc kết nối với các ứng dụng bên ngoài bằng cách sử dụng dữ liệu dành riêng cho tiện ích mở rộng được lưu trữ. Tất cả dữ liệu này có thể được truy cập bằng cách sử dụng ủy quyền cơ bản, nghĩa là bằng tên người dùng và khóa truy cập.
Tạo API REST
Sau đây là năm bước chung mà bạn có thể sử dụng để xây dựng bất kỳ API nào:
- Lập kế hoạch API: Nguyên tắc thiết kế API của bạn được cung cấp bởi thông số kỹ thuật API như OpenAPI. Bạn nên xem xét trước các trường hợp sử dụng khác nhau và đảm bảo API tuân thủ các tiêu chuẩn phát triển API hiện tại.
- Xây dựng API: Các nhà thiết kế API tạo nguyên mẫu của các API mới với ít sửa đổi đối với các API hiện có. Các nhà phát triển có thể điều chỉnh nguyên mẫu cho phù hợp với các yêu cầu nội bộ sau khi nó đã trải qua quá trình thử nghiệm.
- Kiểm tra API: Tương tự như kiểm thử phần mềm, kiểm thử API là cần thiết để bảo vệ chống lại lỗi và sai sót. Kiểm tra sức mạnh của API trước các cuộc tấn công trực tuyến bằng cách sử dụng các công cụ để kiểm tra API.
- Tài liệu API: Mặc dù các API đã tự giải thích nhưng tài liệu hướng dẫn có thể giúp người dùng dễ dàng hơn. Trong kiến trúc hướng dịch vụ, các API được ghi chép đầy đủ với nhiều chức năng và trường hợp sử dụng khác nhau được sử dụng thường xuyên hơn. Viết tài liệu trợ giúp để đưa ra định hướng và giúp người khác xây dựng API của họ.
- Tiếp thị API: Có các thị trường trực tuyến nơi các nhà phát triển có thể mua và bán API cho người khác, giống như các thị trường bán lẻ hàng hóa trên eBay, Amazon và Flipkart. Bạn có thể kiếm tiền từ API của mình bằng cách liệt kê nó.
Blog này sẽ hướng dẫn bạn cách xây dựng lệnh API REST tùy chỉnh bằng Trình thiết kế API của Vtiger. Vậy hãy bắt đầu.
Trình thiết kế API là gì?
Trình thiết kế API là một công cụ hoặc nhà phát triển ứng dụng có thể sử dụng để xây dựng các API dịch vụ web tùy chỉnh. Bạn có thể xác định điểm cuối dịch vụ tùy chỉnh và tham số truy vấn. Các API này có thể được sử dụng để tương tác với dữ liệu CRM, tích hợp với các ứng dụng bên ngoài và cũng hiển thị những dữ liệu này cho API Javascript VTAP để sử dụng trong các trang hoặc tiện ích tùy chỉnh trong giao diện người dùng Vtiger.
Bạn có thể tạo API bằng Ngôn ngữ thiết kế ứng dụng Vtiger (VADL), dựa trên cú pháp XML một cách lỏng lẻo. VADL cho phép quản trị viên hoặc nhà phát triển không có kỹ năng lập trình cấp cao dễ dàng xác định API, nhưng với hiểu biết cơ bản về lập trình, bạn có thể tạo API hiệu quả một cách nhanh chóng.
Các API REST tuân theo giao thức API REST tiêu chuẩn và bạn có thể xác định các điểm cuối của chúng như sau:
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
Đối với API REST, các phương thức yêu cầu HTTP sau được hỗ trợ:
- GET
- POST
- PUT
- DELETE
Hãy cho chúng tôi xem cách bạn có thể sử dụng VTAP để xây dựng API REST tùy chỉnh của mình.
Người dùng Vtiger CRM có thể xây dựng các API REST sẽ kết nối CRM với các ứng dụng của bên thứ ba khác hoặc xây dựng các ứng dụng mới sẽ mở rộng chức năng của CRM. Đây là một ví dụ:
Hãy để chúng tôi tạo một API REST có thể truy cập dữ liệu từ một cụ thể mô-đun sử dụng VTAP.
Sau đây là một ví dụ về API truy xuất dữ liệu từ mô-đun CRM được gọi là Tổ chức để hiển thị năm tổ chức hàng đầu có doanh thu hàng năm cao nhất với tên API là top_tổ chức. Bạn có thể đi với một tên khác để giữ cho nó độc đáo.
Trước khi bắt đầu, hãy cho chúng tôi hiểu các thành phần XML và VDAL sẽ được sử dụng để xác định các hành động của ví dụ API ở trên.
Bảng sau đây mô tả các thành phần XML và VDAL sẽ được sử dụng để xác định API REST tùy chỉnh để truy cập và hiển thị dữ liệu CRM:
| Thành phần XML và VDAL | Hoạt động |
|---|---|
| phương thức api=”lấy” | Xác định phương thức Yêu cầu HTTP |
| chọn mô-đun = "Tài khoản" | Xác định mô-đun để lấy dữ liệu từ việc sử dụng chọn |
| ghi tên trường=”tên tài khoản”> | Xác định các trường trong bản ghi để truy xuất dữ liệu bằng cách sử dụng ghi |
| loại tên trường=”annual_revenue” thứ tự=”giảm dần” /trường /loại |
Xác định các điều kiện cho kết quả bảng bằng cách sử dụng loại |
| giới hạn tối đa=”5″ trang=”@trang” /giới hạn | Xác định số lượng chi tiết bản ghi sẽ được hiển thị bằng cách sử dụng hạn chế |
| /lựa chọn / api |
Kết thúc bằng việc đóng tất cả các thẻ đang mở |
Chú thích rằng tất cả các thành phần XML và VDAL trong bảng trên phải được đính kèm với các thẻ (<>).
Thực hiện theo các bước sau để xây dựng API REST đã thảo luận ở trên:
- Đăng nhập vào tài khoản Vtiger CRM của bạn.
- Nhấn vào Thực đơn chính.
- Nhấp chuột Nền tảng.
- Chọn Trình thiết kế API.
- Nhấp chuột +Thêm API.
- Nhấp chuột Tạo bên cạnh API REST. Cửa sổ Add REST API mở ra.
- Thêm API REST: Nhập hoặc chọn thông tin cho các mục sau:
- Mô-đun: Chọn mô-đun CRM mà dữ liệu phải được truy cập từ đó.
- Họ tên: Nhập mã định danh duy nhất cho API.
- Trạng thái: Nhấp vào Hộp kiểm để kích hoạt API.
- Nhấp chuột Lưu.
- Sau khi thêm API, bạn sẽ thấy một IDE tích hợp sẵn nơi bạn sẽ sử dụng VADL để xác định API và các nút XML để truy xuất dữ liệu CRM. Tham khảo bảng trên để hiểu các thành phần XML và VADL.
- Nhấp chuột Lưu và xuất bản để xuất bản API đã xây dựng.
Bạn có thể truy cập và kiểm tra API REST ở trên từ bất kỳ ứng dụng bên ngoài nào bằng URL sau.
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
Chú thích rằng URL ở trên là một ví dụ và bạn sẽ phải xác định điểm cuối theo phiên bản CRM của mình.
Bạn có biết?
Dữ liệu trên có thể được sử dụng để hiển thị dưới dạng danh sách trên trang tùy chỉnh hoặc được sử dụng cho biểu đồ thanh và các kết quả động khác bằng cách sử dụng các thành phần javascript để xác định API của bạn. Tất cả các API REST tùy chỉnh được tích hợp trong Trình thiết kế API cũng có thể được truy cập bằng cách sử dụng API VTAP Javascript.
Để biết thêm về cách xây dựng API tùy chỉnh và VTAP, hãy xem Tài liệu VTAP.
