Πρώτα βήματα

Έλεγχος ταυτότητας

Κάθε αίτημα περιέχει το κλειδί API σας. Το κλειδί προσδιορίζει τον χρήστη σας και καθορίζει τι μπορεί να περιλαμβάνει η απόκριση.

1Στον πίνακα ελέγχου, ανοίξτε την ενότητα Ο λογαριασμός μου › API και κάντε κλικ στο Δημιουργία κλειδιού. Δώστε ένα όνομα που να θυμίζει πού θα χρησιμοποιηθεί το κλειδί, π.χ. «Παρακολούθηση».
2Αντιγράψτε το κλειδί αμέσως: για λόγους ασφαλείας, εμφανίζεται μόνο μία φορά. Αν το χάσετε, ανακαλέστε το και δημιουργήστε νέο.
3Στείλτε το κλειδί στην κεφαλίδα X-API-Key ή ως Authorization: Bearer.

Χρησιμοποιείτε το κλειδί μόνο στον διακομιστή. Μην το βάζετε ποτέ σε ιστοσελίδες, εφαρμογές ή συνδέσμους: το API απορρίπτει κλειδιά που αποστέλλονται στη διεύθυνση URL. Κάθε χρήστης μπορεί να έχει έως 10 ενεργά κλειδιά και να ανακαλέσει οποιοδήποτε από αυτά στην ίδια καρτέλα του πίνακα ελέγχου.

Μορφή κλειδιού

Το κλειδί ξεκινά με apk_, ακολουθούμενο από 48 χαρακτήρες. Στον πίνακα ελέγχου, κάθε κλειδί εμφανίζεται μόνο με την αρχή του, την ίδια τιμή με το πεδίο api_key.prefix του /me.

Ανάκληση και αντικατάσταση κλειδιών

Η ανάκληση ενός κλειδιού μπλοκάρει αμέσως τα αιτήματα που γίνονται με αυτό. Για να αντικαταστήσετε το κλειδί χωρίς να σταματήσετε το σύστημά σας, δημιουργήστε το νέο, αλλάξτε το στον διακομιστή και μόνο τότε ανακαλέστε το παλιό.

Αν το σύστημά σας χρειάζεται μόνο μέρος των δεδομένων, δημιουργήστε στον πίνακα ελέγχου έναν χρήστη ειδικά για αυτό, με μόνο τα απαραίτητα δικαιώματα, και δημιουργήστε το κλειδί στον λογαριασμό αυτού του χρήστη.

Τι βλέπει κάθε χρήστης

Αίτημα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."
  }
}