Memulai

Autentikasi

Setiap permintaan menyertakan kunci API Anda. Kunci ini mengidentifikasi pengguna Anda dan menentukan apa yang boleh dikembalikan dalam respons.

1Di panel kontrol, buka Akun Saya › API lalu klik Buat kunci. Beri nama yang mengingatkan Anda di mana kunci akan digunakan, misalnya “Pemantauan”.
2Segera salin kunci: demi keamanan, kunci hanya ditampilkan satu kali. Jika hilang, cabut kunci tersebut dan buat yang baru.
3Kirim kunci di header X-API-Key atau sebagai Authorization: Bearer.

Gunakan kunci hanya di server. Jangan pernah menaruhnya di halaman web, aplikasi, atau tautan: API menolak kunci yang dikirim di URL. Setiap pengguna dapat memiliki hingga 10 kunci aktif dan dapat mencabut kunci mana pun di tab yang sama pada panel kontrol.

Format kunci

Kunci diawali dengan apk_, diikuti 48 karakter. Di panel kontrol, setiap kunci hanya ditampilkan bagian awalnya, yaitu nilai yang sama dengan field api_key.prefix dari /me.

Mencabut dan mengganti kunci

Mencabut kunci akan langsung memblokir permintaan yang dibuat dengan kunci tersebut. Untuk mengganti kunci tanpa menghentikan sistem Anda, buat kunci baru, pasang di server, lalu baru cabut kunci yang lama.

Jika sistem Anda hanya memerlukan sebagian data, buat pengguna khusus untuk sistem itu di panel kontrol, hanya dengan izin yang diperlukan, lalu buat kunci di akun pengguna tersebut.

Apa yang dapat dilihat setiap pengguna

PermintaancURLPHPJavaScript

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

Dengan header Authorization

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

Tanpa kunci atau kunci sudah dicabut401

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