Xác thực

Để truy cập Partner API, bạn cần xác thực bằng khóa bí mật API. Tạo và quản lý khóa của bạn thông qua Partner Console.

Khóa API đóng vai trò là thông tin xác thực để bạn truy cập tài nguyên đối tác. Mỗi khóa chỉ có quyền truy cập hạn chế vào dữ liệu của các tổ chức cụ thể và có thể bị vô hiệu hóa ngay lập tức khi cần.

Hãy bảo quản khóa API của bạn cẩn thận, vì chúng cung cấp toàn quyền truy cập vào tài khoản của bạn! Không bao giờ để lộ các khóa này trong kho mã công khai, ứng dụng phía máy khách hoặc bất kỳ nơi nào có thể bị xâm phạm.

Xác thực yêu cầu bằng HTTP Basic Auth bằng cách truyền khóa API của bạn làm tên người dùng. Để trống mật khẩu.

API chỉ chấp nhận kết nối HTTPS bảo mật. Các yêu cầu HTTP thông thường sẽ bị từ chối, cũng như mọi yêu cầu thiếu thông tin xác thực hợp lệ.

Yêu cầu mẫu

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

Xác minh khóa bí mật

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }