Nhảy tới nội dung
Phiên bản: 3.0.0

Hướng dẫn chạy API

Hướng dẫn này sẽ giúp Đối tác thiết lập Postman và chạy thử một collection API mẫu của Ahamove. Postman là một công cụ phổ biến để kiểm tra API và mô phỏng các yêu cầu.

Bước 1: Cài Đặt Postman

  1. Truy cập trang web Postman và tải phiên bản phù hợp với hệ điều hành của Đối tác.
  2. Cài đặt Postman và đăng nhập (hoặc tạo tài khoản nếu chưa có).

Bước 2: Nhập Collection API Ahamove V3

  1. Tải xuống collection API Ahamove V3 Tại đây.
  2. Mở Postman, nhấn vào nút Import ở góc trên bên trái.
  3. Kéo và thả tệp collection đã tải xuống hoặc dán link collection hoặc nhấn Upload Files để nhập nó.
  4. Bạn sẽ thấy collection Ahamove API v3 được thêm vào thanh bên dưới mục Collections.

Bước 3: Thiết Lập Biến Môi Trường

  1. Trong Postman, nhấn vào biểu tượng bánh răng ⚙️ ở góc trên bên phải và chọn Manage Environments.
  2. Tạo một môi trường mới với tên Ahamove API STG.
  3. Thêm các biến sau (thay thế các giá trị mẫu bằng dữ liệu thực tế):
    • partner_host: The Staging domain API (https://partner-apistg.ahamove.com)
    • api_key: API Key Staging đã nhận được khi đăng ký tích hợp
    • token: Để trống cho đến khi bạn tạo token tại Bước 4.
  4. Lưu môi trường và đảm bảo đã chọn môi trường đó từ menu dropdown ở góc trên bên phải của Postman.

Bước 4: Xác Thực và Lấy Token

  1. Tìm API Đăng ký tài khoản hoặc Lấy token (nếu đã có sẵn tài khoản) trong collection.
  2. Nhập API key và các trường thông tin bắt buộc.
  3. Gửi yêu cầu và lấy token từ phản hồi.
  4. Sao chép token và dán vào biến môi trường token.

Bước 5: Chạy Thử API Mẫu

  1. Sử dụng token cho các endpoint yêu cầu xác thực.
  2. Chọn API Lấy danh sách các dịch vụ (hoặc một endpoint khác).
  3. Nhấn Send để thực thi yêu cầu.
  4. Xác minh phản hồi:
    • Mã trạng thái: 200 OK
    • Nội dung phản hồi: Danh sách các loại dịch vụ được hỗ trợ bởi Ahamove.

Bước 6: Khám Phá Các Endpoint API Khác

  1. Sử dụng token cho các endpoint yêu cầu xác thực.
  2. Kiểm tra các tính năng nâng cao như ước tính phí, tạo đơn hàng hoặc lấy chi tiết đơn hàng.
  3. Thay đổi tham số yêu cầu (ví dụ: vị trí, thời gian, cod) để mô phỏng các tình huống vận hành thực tế.