Documentation

Introduction à l'API

Pour faire très simple, une API (pour Application Programming Interface) est une interface de programmation qui va permettre à vos applications de gérer l'ensemble des fonctionnalités de vos comptes alwaysdata. Notre API se veut moderne : elle respecte l'architecture REST (pour REpresentational State Transfer) et propose différents formats de sérialisation des données.

Utilisation

Théoriquement il est possible, via l'API, d'effectuer toutes les opérations disponibles sur votre compte alwaysdata (dans la pratique, certaines opérations peuvent ne pas être encore disponibles mais en cours de développement par nos équipes).

Les opérations possibles peuvent être catégorisées de cette manière :

  • opérations « classiques » : ajout/suppression/modification d'une ressource (un compte ftp, une boîte email, etc.) ;
  • opérations « spécifiques » : redémarrage d'une application, sauvegarde d'une base de données, etc.

Architecture REST

Ce type d'architecture est particulièrement bien adapté aux applications Internet et voici quelques éléments pour mieux comprendre ses principes :

  • basé sur la représentation de ressources : chaque élément de votre compte comme par exemple un utilisateur FTP, une boîte email ou encore un certificat SSL.
  • au-dessus du protocole HTTP :
    • permet d'exploiter son enveloppe et ses en-têtes ;
    • de respecter également le principe d'URI afin d'identifier une ressource ;
    • un verbe HTTP (GET, POST, PUT, DELETE) correspond à une opération sur une ressource.
  • pas de notion d'état : les requêtes sont indépendantes ce qui permet d'avoir des traitements bien distincts entre le client (votre application) et le serveur (notre API) et par conséquent de faciliter la maintenance de part et d'autre.

Liens externes


Dernière mise à jour : 09 oct. 2013 à 14:44