Per iniziare

Autenticazione

Ogni richiesta include la tua chiave API. La chiave identifica il tuo utente e determina cosa può contenere la risposta.

1Nel pannello di controllo, apri Il mio account › API e fai clic su Genera chiave. Assegnale un nome che ricordi dove verrà usata, ad esempio «Monitoraggio».
2Copia subito la chiave: per motivi di sicurezza, viene mostrata una sola volta. Se la perdi, revocala e generane un'altra.
3Invia la chiave nell'intestazione X-API-Key oppure come Authorization: Bearer.

Usa la chiave solo sul server. Non inserirla mai in pagine web, app o link: l'API rifiuta le chiavi inviate nell'URL. Ogni utente può avere fino a 10 chiavi attive e può revocarne una qualsiasi nella stessa scheda del pannello di controllo.

Formato della chiave

La chiave è composta da apk_ seguito da 48 caratteri. Nel pannello di controllo, ogni chiave è mostrata solo con la parte iniziale, lo stesso valore del campo api_key.prefix di /me.

Revocare e sostituire le chiavi

La revoca di una chiave blocca immediatamente le richieste fatte con essa. Per sostituire la chiave senza fermare il tuo sistema, genera quella nuova, aggiornala sul server e solo dopo revoca quella vecchia.

Se il tuo sistema ha bisogno solo di una parte dei dati, crea nel pannello di controllo un utente dedicato, con i soli permessi necessari, e genera la chiave nell'account di quell'utente.

Cosa può vedere ogni utente

RichiestacURLPHPJavaScript

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

Con l'intestazione Authorization

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

Chiave mancante o revocata401

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