Premiers pas

Authentification

Chaque requête doit inclure votre clé d'API. Elle identifie votre utilisateur et détermine ce que la réponse peut contenir.

1Dans le panneau de contrôle, ouvrez Mon compte › API et cliquez sur Générer une clé. Donnez-lui un nom qui rappelle où la clé sera utilisée, par exemple « Supervision ».
2Copiez la clé tout de suite : pour des raisons de sécurité, elle n'est affichée qu'une seule fois. Si vous la perdez, révoquez-la et générez-en une autre.
3Envoyez la clé dans l'en-tête X-API-Key ou sous la forme Authorization: Bearer.

Utilisez la clé uniquement côté serveur. Ne la mettez jamais dans des pages web, des applications ou des liens : l'API refuse les clés envoyées dans l'URL. Chaque utilisateur peut avoir jusqu'à 10 clés actives et peut révoquer n'importe laquelle d'entre elles dans le même onglet du panneau de contrôle.

Format de la clé

La clé se compose de apk_ suivi de 48 caractères. Dans le panneau de contrôle, chaque clé n'est affichée que par son début, c'est-à-dire la valeur du champ api_key.prefix de /me.

Révoquer et remplacer des clés

La révocation d'une clé bloque immédiatement les requêtes faites avec celle-ci. Pour remplacer une clé sans interrompre votre système, générez la nouvelle, mettez-la en place sur votre serveur, puis révoquez l'ancienne.

Si votre système n'a besoin que d'une partie des données, créez dans le panneau de contrôle un utilisateur qui lui est dédié, avec uniquement les permissions nécessaires, et générez la clé dans le compte de cet utilisateur.

Ce que chaque utilisateur peut voir

RequêtecURLPHPJavaScript

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

Avec l'en-tête Authorization

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

Clé absente ou révoquée401

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