Login

Documentation

Introduction to API

To make it simple, an API (for Application Programming Interface) is a programming interface which will allows your application to manage all the features of your alwaysdata accounts. Our API intends to be modern: it respects the REST (for REpresentational State Transfer) and offers different data serialization formats.

Use

In theory, it is possible to perform all operations available on your alwaysdata account via the API (in practice some operations may be not yet available but under development by our teams).

Possible operations can be categorized as:

  • "classic" operations: add/removal/modification of ressource (FTP account, mailbox, etc.);
  • "specific" operations: application restart, database backup, etc.

REST architecture

This type of architecture is particularly well suited to Internet applications. Here are some elements to better understand its principles:

  • based on ressources representation: each element of your account as a FTP user, a mailbox or a SSL certificate.
  • above the HTTP protocol :
    • allows to exploit its envelope and headers;
    • to also respect the URI concept to identify a ressource;
    • a HTTP (GET, POST, PUT, DELETE) verb match an operation on a ressource.
  • no status notion: requests are independent allowing distincts treatments between the client (your application) and the server (our API) and consequently facilitating maintenance on both sides.

Last updated: 05 Dec. 2018 at 14:16