Эхлэх

Баталгаажуулалт

Хүсэлт бүр Таны API түлхүүрийг агуулна. Энэ нь Таны хэрэглэгчийг тодорхойлж, хариунд юу орж болохыг шийднэ.

1Хяналтын самбарт Миний бүртгэл › API хэсгийг нээгээд Түлхүүр үүсгэх дээр дарна уу. Түлхүүрийг хаана ашиглахыг сануулах нэр өгнө үү, жишээ нь «Мониторинг».
2Түлхүүрийг шууд хуулж авна уу: аюулгүй байдлын үүднээс үүнийг зөвхөн нэг удаа харуулна. Хэрэв алдвал хүчингүй болгоод шинийг үүсгэнэ үү.
3Түлхүүрийг X-API-Key толгойд эсвэл Authorization: Bearer хэлбэрээр илгээнэ үү.

Түлхүүрийг зөвхөн сервер дээр ашиглана уу. Үүнийг вэб хуудас, апп эсвэл холбоосонд хэзээ ч бүү оруулаарай: API хаягаар илгээсэн түлхүүрийг хүлээн авахгүй. Хэрэглэгч бүр 10 хүртэл идэвхтэй түлхүүртэй байж болох бөгөөд аль нэгийг нь хяналтын самбарын мөн тэр табаас хүчингүй болгож болно.

Түлхүүрийн формат

Түлхүүр apk_ гэж эхэлж, араас нь 48 тэмдэгт байна. Хяналтын самбарт түлхүүр бүрийн зөвхөн эхний хэсэг харагдах бөгөөд энэ нь /me хариуны api_key.prefix талбарын утгатай ижил.

Түлхүүрийг хүчингүй болгох ба солих

Түлхүүрийг хүчингүй болгомогц түүгээр илгээсэн хүсэлтүүд шууд хаагдана. Системээ зогсоолгүйгээр түлхүүр солихын тулд шинийг үүсгээд сервер дээрээ сольж, дараа нь л хуучныг хүчингүй болгоно уу.

Хэрэв Таны системд өгөгдлийн зөвхөн тодорхой хэсэг хэрэгтэй бол хяналтын самбарт зөвхөн түүнд зориулж, шаардлагатай эрхүүдтэй тусдаа хэрэглэгч үүсгээд, тэр хэрэглэгчийн бүртгэлд түлхүүр үүсгэнэ үү.

Хэрэглэгч бүр юуг харж чадах вэ

ХүсэлтcURLPHPJavaScript

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();

Authorization толгойтой

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

Түлхүүргүй эсвэл хүчингүй болсон түлхүүртэй401

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