Bắt đầu

Xác thực

Mọi yêu cầu đều phải kèm khóa API của bạn. Khóa xác định người dùng của bạn và quyết định phản hồi được phép trả về những gì.

1Trong bảng điều khiển, mở Tài khoản của tôi › API rồi nhấp Tạo khóa. Đặt một cái tên gợi nhớ nơi khóa sẽ được dùng, chẳng hạn “Giám sát”.
2Sao chép khóa ngay: vì lý do bảo mật, khóa chỉ hiển thị một lần. Nếu làm mất, hãy thu hồi và tạo khóa khác.
3Gửi khóa trong header X-API-Key hoặc dưới dạng Authorization: Bearer.

Chỉ dùng khóa trên máy chủ. Tuyệt đối không đặt khóa vào trang web, ứng dụng hoặc liên kết: API từ chối khóa được gửi trong URL. Mỗi người dùng có thể có tối đa 10 khóa đang hoạt động và có thể thu hồi bất kỳ khóa nào ngay trong thẻ đó của bảng điều khiển.

Định dạng khóa

Khóa bắt đầu bằng apk_, theo sau là 48 ký tự. Trong bảng điều khiển, mỗi khóa chỉ hiển thị phần đầu, cũng chính là giá trị của trường api_key.prefix trong /me.

Thu hồi và thay khóa

Thu hồi một khóa sẽ chặn ngay các yêu cầu dùng khóa đó. Để thay khóa mà không làm gián đoạn hệ thống, hãy tạo khóa mới, cập nhật trên máy chủ rồi mới thu hồi khóa cũ.

Nếu hệ thống của bạn chỉ cần một phần dữ liệu, hãy tạo trong bảng điều khiển một người dùng riêng cho hệ thống đó, chỉ với các quyền cần thiết, rồi tạo khóa trong tài khoản của người dùng này.

Mỗi người dùng thấy được gì

Yêu cầucURLPHPJavaScript

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Với header Authorization

curl "https://api.on-cloud.live/v1/me" \
  -H "Authorization: Bearer $API_KEY"

Thiếu khóa hoặc khóa đã bị thu hồi401

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid or has been revoked."
  }
}