Başlarken

Kimlik doğrulama

Her istek API anahtarınızla gönderilir. Anahtar, kullanıcınızı tanımlar ve yanıtta nelerin yer alabileceğini belirler.

1Kontrol panelinde Hesabım › API bölümünü açın ve Anahtar oluştur düğmesine tıklayın. Anahtara, nerede kullanılacağını hatırlatan bir ad verin, ör. “İzleme”.
2Anahtarı hemen kopyalayın. Güvenlik nedeniyle yalnızca bir kez gösterilir. Kaybederseniz anahtarı geçersiz kılın ve yeni bir anahtar oluşturun.
3Anahtarı X-API-Key başlığında veya Authorization: Bearer olarak gönderin.

Anahtarı yalnızca sunucuda kullanın. Anahtarı asla web sayfalarına, uygulamalara veya bağlantılara eklemeyin; API, URL'de gönderilen anahtarları reddeder. Her kullanıcının en fazla 10 etkin anahtarı olabilir ve kullanıcı bunlardan herhangi birini kontrol panelinin aynı sekmesinden geçersiz kılabilir.

Anahtar biçimi

Anahtar apk_ ile başlar ve ardından 48 karakter gelir. Kontrol panelinde her anahtarın yalnızca başlangıç kısmı gösterilir; bu kısım, /me yanıtındaki api_key.prefix alanının değeriyle aynıdır.

Anahtarları geçersiz kılma ve değiştirme

Bir anahtarı geçersiz kıldığınızda, o anahtarla yapılan istekler anında engellenir. Sisteminizi durdurmadan anahtarı değiştirmek için yeni anahtarı oluşturun, sunucunuzda eskisiyle değiştirin ve ancak bundan sonra eski anahtarı geçersiz kılın.

Sisteminiz verilerin yalnızca bir kısmına ihtiyaç duyuyorsa kontrol panelinde yalnızca bu sistem için, gereken izinlere sahip bir kullanıcı oluşturun ve anahtarı bu kullanıcının hesabında oluşturun.

Her kullanıcı neleri görebilir

İstekcURLPHPJavaScript

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 başlığıyla

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

Anahtar yok veya geçersiz kılınmış401

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