Skip to main content

Cách đăng ký OpenAPI và kiểm thử trực tuyến

Rock API cho phép người mua đăng ký một dịch vụ OpenAPI và kiểm thử request trực tuyến trước khi viết mã tích hợp. Hướng dẫn này dựa trên video RockAPI How to use normal openapi?.
Cập nhật lần cuối: 23/05/2026

Quy trình này dùng để làm gì

Dùng quy trình này khi bạn muốn đánh giá một dịch vụ OpenAPI bên thứ ba trước khi kết nối vào ứng dụng. Bước kiểm thử trực tuyến giúp xác nhận xác thực, tham số request, trường response và lỗi mà không cần cấu hình client cục bộ trước.

Bước 1: chọn dịch vụ OpenAPI

Mở trang chi tiết API và xem các thông tin cần thiết cho môi trường production:
  • API làm gì và hỗ trợ những use case nào.
  • Những endpoint nào nằm trong gói đăng ký.
  • Giá, quota và rate limit được tính như thế nào.
  • Tài liệu có ví dụ request và response hay không.
  • Sau khi đăng ký cần dùng phương thức xác thực nào.
Nếu API sẽ được dùng trong production, hãy lưu thông tin gói vào tài liệu nội bộ trước khi đăng ký.

Bước 2: đăng ký API

Sau khi chọn dịch vụ, đăng ký từ trang chi tiết API. Trước khi xác nhận, kiểm tra gói đã chọn, điều khoản thanh toán và giới hạn sử dụng. Khi đăng ký có hiệu lực, Rock API có thể cấp quyền cho các lệnh gọi kiểm thử và lệnh gọi từ ứng dụng đối với API đó. Nên gắn đăng ký và API key với đúng dự án hoặc môi trường để không trộn traffic thử nghiệm với production.

Bước 3: mở console kiểm thử trực tuyến

Dùng khu vực kiểm thử trực tuyến trong tài liệu API để gửi request từ trình duyệt. Bắt đầu với endpoint đơn giản nhất, sau đó thêm tham số tùy chọn khi request cơ bản đã thành công. Trước khi gửi request, hãy kiểm tra:
  • HTTP method và endpoint path.
  • Header bắt buộc, bao gồm authorization.
  • Query parameter hoặc trường JSON body bắt buộc.
  • Giá trị mẫu trong tài liệu.

Bước 4: đọc response

Một lần kiểm thử trực tuyến thành công phải trả về status code và response body khớp với tài liệu. Kiểm tra các trường mà ứng dụng sẽ phụ thuộc vào, ví dụ ID, trạng thái, trường phân trang hoặc URL kết quả. Nếu kiểm thử thất bại, dùng response lỗi để xác định nguyên nhân:

Bước 5: chuyển từ kiểm thử trực tuyến sang code

Sau khi kiểm thử trong trình duyệt thành công, đưa cấu trúc request đã xác nhận vào ứng dụng. Giữ các chi tiết sau nhất quán:
  • Base URL và endpoint path.
  • HTTP method.
  • Header và định dạng authorization.
  • Trường JSON body và kiểu dữ liệu.
  • Response thành công và response lỗi dự kiến.
Xem ví dụ triển khai với curl, Node.js hoặc Python.

Checklist cho người mua

  • Bạn hiểu giá, quota và rate limit của API.
  • Bạn đã đăng ký bằng đúng tài khoản hoặc dự án.
  • Kiểm thử trực tuyến trả về response hợp lệ.
  • Bạn đã lưu ví dụ request chạy được cho đội phát triển.
  • Bạn biết ứng dụng cần xử lý những lỗi nào.
  • Bạn đã xem quản lý API key an toàn trước khi dùng production.

Câu hỏi thường gặp

Cách nhanh nhất để kiểm thử OpenAPI sau khi đăng ký là gì?

Cách nhanh nhất là dùng console kiểm thử trực tuyến trong tài liệu API. Bạn có thể gửi request từ trình duyệt và xem status code, response body và chi tiết lỗi.

Tôi có cần viết code trước khi kiểm thử API không?

Không. Bạn có thể dùng console kiểm thử trực tuyến trước. Sau khi request kiểm thử thành công, chuyển cùng endpoint, header và body đó sang curl, Node.js, Python hoặc mã ứng dụng.

Vì sao kiểm thử API trực tuyến trả về 401 hoặc 403?

401 hoặc 403 thường có nghĩa là request chưa được cấp quyền. Kiểm tra đăng ký đã hoạt động, API key hợp lệ và request có header authorization bắt buộc.

Cần kiểm tra gì trước khi dùng API trong production?

Kiểm tra giá, rate limit, định dạng response, xử lý lỗi, logging và cách lưu key. Dùng checklist đăng ký API trước khi có traffic production.