Documentation API Publique

Documentation de l'API publique EAsy

Présentation générale

L'API publique d'e-ASY permet de s'interfacer avec les données d'un projet par l'intermédiaire de requêtes HTTP.

Chaque projet dispose d'une API de type REST accessible via les requêtes et paramètres décrits ci-dessous.

Principe d'utilisation

L'utilisation de l'API est cloisonnée aux données d'un projet. L'URL de base pour toutes les requêtes dépend du projet. Les paramètres sont passés à la suite de l'URL ou bien par données POST selon les cas.

URL de base

https://{nom-projet}.e-asyapp.com/api/public

Cette URL sert de base à toutes les requêtes décrites dans cette documentation.

Requêtes publiques

Version de l'API

Requête pour récupérer la version courante du serveur d'API.

Method

  • GET

Path

/version

Paramètres

Valeur de retour

Format JSON:

{
    "status": 202,
    "message": null,
    "data": "1.0.0"
}

Exemple

URL :

  • http://dps.localhost/api/public/version

Authentification

Requête permettant de récupérer le token d'authentification.

Method

  • POST

Path

/oauth/token

Paramètres

Les paramètres sont passés en JSON dans le corps de la requête.

  • email (string) : L'email de l'utilisateur
  • password (string) : Le mot de passe de l'utilisateur

Valeur de retour

  • token_type (string) : Bearer: le type de token Oauth.
  • access_token (string) : Token d'authentification à utiliser dans toutes les requêtes nécessitant d'être authentifié.
  • refresh_token (string) : Token de rafraichissement pour regénérer un nouveau token sans renvoyer le mot de passe
  • expires (integer) : Timestamp UNIX, date d'expriation du token

Format JSON :

{
    "status": 202,
    "message": null,
    "data":{
        "token_type": "Bearer",
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjVjNDIzYzk1NDM0ZTdlMTY1NDI0MDdjZGU4ZGUxNjY3NmUwODhkZTVhZWU5NDBkNzE3NTUxOWFjNGIzMzdhMDE3ODBlNzI2NjFmZjVhOWY4In0.eyJhdWQiOiIxIiwianRpIjoiNWM0MjNjOTU0MzRlN2UxNjU0MjQwN2NkZThkZTE2Njc2ZTA4OGRlNWFlZTk0MGQ3MTc1NTE5YWM0YjMzN2EwMTc4MGU3MjY2MWZmNWE5ZjgiLCJpYXQiOjE1OTIzMTUxMjMsIm5iZiI6MTU5MjMxNTEyMywiZXhwIjoxNTkyNDAxNTIzLCJzdWIiOiI1MSIsInNjb3BlcyI6W119.MJC1__riCGFK1A5rLzDe0t0QnnBiH2u6Z7ImG4U_3z8o1JPf75F3PsvwFlDT4Csq18CDb2VAe9akRfh3uRDD1ZUdFek5JULoqHahY2gjN2-kaFDgDHyJc2teuDdRzzDYXry3kK-ndjFyHgakAfQf75lWmBlkKPYfkd3RAMCPIv7BEZ6ZWKKLyk7Sm35ffvv0YJ9jeCKa0B3fWoxYZLWgYip6bf_gZ4-1gQzDC9-B5NYK2sFEOrEPg5O7DxawrEZOjgiG-mfc-UsDbJWtTp0y3phuTIzRTun7F5S7aAws2fDd33K9XTGQixtsGv1Ofk9fLSjLVkvtA2JK_uVN4zgymER2LAMBifaozt8bpz4QZgL0g4z4J5UPMVdT4mU5e7YmA_EGyV4WyCWOt1F-EuRoYKO4DxMxHrza9wJe8D0HbqreGDCMxKKlEiJx47Zp870YANKi0F4PM_T5c0v7KOOx5Q9i1JVje_pYlZ4nViJm4GtACMo6fj2HmQ_LKLMykxE6EvTYktQP4G7YX8RhZfSoW0k1o5JRJ744r5fzumfjM-FMoiAUhqLTRSy4i7KwGJaq3XF9bO1JXGGkc-5MNQNmOzxPR___okstlcmqTVbrZNY0_Q_zRzb848hO48XhW57sNwgYr6aB1go-7IWcBb10xc2qv9sAkQH6w1iYm8ShZiI",
        "refresh_token": "def50200f53b20d6b5beb8f8e81e3d7f0271442ca447332e7e71e788ab289e460a018fa5fe6a0825a540a67c443b265bd62d48cfd2069d25f4589e3ac758e0a5ea67a9ff7b35e25214eff25a358601893f9d16ca7c905db1fef16f7591e7cafe1a85d5c09dbdc60dacfc5c983e27d398121ca03373ec1a134a9b17cad62453706ee8b636ddce31c28439b3d84340812b689cb1435ffda59190653282ad4802b401b7e3b50c90aa5052a71a40bdb60af4b95dca5b7977ac38321aaa5157a050a75a34a6f0c20a64327a1deb1e6109fe22ffe74bc4862cf4b10a76fba831a9b8645ff8dcba0bb729c7db586849299cf9ac7a98fd27e99ac397147eddff188bb3568e2f1cf481b2ea648351b2ce4b9bca2bd5c0a3a985a42152fd67e5f88f27d9174b913746ac8d3256b49d64355675b417957a9ec7d17dbe8a9340a4c5b5d33363f8134fba287189d03678aedf5a831e9f3630e09ed04fbade421e045fc22a3cd5a542",
        "expires": 1592401523
    }
}

Exemple d'appel

URL :

  • http://dps.localhost/api/public/oauth/token

Body:

{
  "email": "user@email.com",
  "password": "********"
}

Documentation complète des requêtes

Documentation pour les développeurs

Les requêtes sont décrites et tenues à jour au fil des évolutions sur le swaggerhub d'Elipce:

https://app.swaggerhub.com/apis-docs/Elipce/e-ASY_API

XML Projet →