Magento 2 sử dụng công cụ Swagger được tích hợp sẵn (đi kèm với mỗi phiên bản Magento 2) để tạo tài liệu REST API ngay lập tức. Tính năng đặc biệt của công cụ này là trình bày các mothod có sẵn cho phiên bản Magento của bạn, vì vậy đó là một điểm cộng vì thông tin luôn được cập nhật trên trang web của bạn. Trong bài viết này chúng ta sẽ cùng nhau tìm hiểu về cách sử dụng Api thông qua Swagger trong Magento 2.
Một điểm nổi bật khác của Swagger đó là bạn có thể thực thi Api trực tiếp trên trình duyệt của bạn, vì thế bạn có thể kiểm tra giá trị trả về là gì.
Nếu bạn chưa biết gì về Api trong Magento 2 hãy xem lại bài Api trong Magento 2 là gì?
Sử dụng Api thông qua Swagger
Để có thể sử dụng Swagger, đầu tiên bạn cần truy cập vào swagger bằng cách thêm từ “swagger” vào sau URL website của bạn.
https://example.com/swagger
Khi bạn đã truy cập vào trang swagger thì bạn có thể thấy các method có sẵn cho guest user.
Magento 2 Api các loại user
Có 3 loại user có quyền truy cập vào tài nguyên của Magento với các phân quyền khác nhau:
- Guest user truy cập vào tài nguyên Magento với quyền anonymous.
- Administrator truy cập vào các tài nguyên của Magento với quyền được cấu hình ở admin.
- Customer truy cập vào các tài nguyên với quyền self hoặc anonymous.
Tạo integration
Khi bạn truy cập vào trang swagger thì bạn chỉ thấy được các method có sẵn cho guest user. Để truy cập được các method dành cho Administrator bạn cần tạo một token như sau:
Tìm integrationAdminTokenServiceV1 tại trang swagger và nhấn vào button Try it out và nhập vào các thông số cần thiết:
Sau đó nhấn button Excute để thực thi Api.
Và đây là kết quả trả về:
Ở phần trên chúng ta đã gửi Api với tham số là username và password của admin và lấy được mã token afco38ctw2l77g2zcqizuj9d7rv4z980. Chúng ta sẽ dùng mã token để điền vào input api_key trên header để có thể thấy được tất cả các method có sẵn dành cho Administrator user.
Kết luận
Vừa rồi chúng ta đã tìm hiểu về cách sử dụng Api thông qua Swagger. Việc sử dụng các method khác cũng tương tự như vậy, bạn chỉ cần điền đầy đủ tham số cần thiết và thực thi thôi. Nếu các bạn có thắc mắc gì thì hãy để lại bình luận bên dưới nhé.
Bài viết tham khảo: https://amasty.com/blog/how-to-start-with-magento-2-api/