Utilisation de l'API

Découvrez notre offre de Cloud Public

L'hébergement mutualisé pour tou·te·s, imaginé par des développeur·euse·s, pour des développeur·euse·s.

Découvrir le Cloud Public

Identification

$ curl --basic --user APIKEY: https://api.alwaysdata.com/v1/account/

Vos tokens sont disponibles dans le menu Profil.

Pour l’utilisation de vos tokens, n’oubliez pas les deux points (:) après la clé, ce qui permet de préciser que le mot de passe n’est pas nécessaire.

Une limite du nombre de requêtes à l’API s’applique. Plus d’informations ici.

Ressources liées

Si vous accédez à des ressources liées à un utilisateur ou un compte spécifique, vous devez le spécifier lors de votre authentification en spécifiant un ou plusieurs paramètre(s) :

  • account : il s’agit du compte auquel vous désirez accéder. Si par exemple vous avez plusieurs comptes mais souhaitez accéder à une ressource d’un compte précis.
  • customer : si vous disposez de certaines permissions sur un autre utilisateur, alors vous devez spécifier son adresse email.

Par exemple, accédez aux utilisateurs FTP de votre compte mycompany de cette manière :

$ curl --basic --user "APIKEY account=mycompany:" https://api.alwaysdata.com/v1/ftp/

Format

Les formats gérés sont les suivants :

  • JSON (par défaut)
  • XML
  • HTML (pour la réponse uniquement)

Il peut être spécifié dans l’URI :

$ curl --basic --user APIKEY: https://api.alwaysdata.com/v1/account/?_format=xml

Ou via le header HTTP :

$ curl --basic --user APIKEY: --header 'Accept: application/xml' https://api.alwaysdata.com/v1/account/

En-têtes HTTP

En-tête HTTPDescriptionValeur par défaut
alwaysdata-synchronousExécution des requêtes en mode synchroneno

Rate-limit

Une limite d’actions par minute est mise en place :

  • 10 requêtes par minute
  • 50 requêtes pour les connexions permanentes
  • 250 requêtes pour les méthodes safe comme GET