Utilisation de l'API

Identification

Avec identifiants (email de profil et mot de passe associé) :

$ curl --basic --user foobar@example.org https://api.alwaysdata.com/v1/account/

Avec votre clé API :

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

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

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