libertempo/api

Tuesday, July 31, 2018
by Prytoegrian
Repository
2 Watchers
1 Stars
1 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
5 Open issues
15 Versions
0 % Grown

The README.md

libertempo-api

, _(*1)

Panthéon

, _(*2)

API Libertempo

Initialisation

L'installation sous sa forme la plus simple se résume à faire :, _(*3)

git clone git@github.com:libertempo/api.git
cd api
make install
ln -sf `pwd`/Tools/Scripts/post-checkout .git/hooks/post-checkout

L'API Libertempo doit être installée comme un domaine à part, autrement dit : - api.libertempo.tld - api.libertempo.mon-entreprise.tld, _(*4)

Et non pas comme un sous-répertoire de votre domaine existant : - mon-entreprise.tld/libertempo/api - libertempo.mon-entreprise.tld/api, _(*5)

C'est préférable pour l'isolation des systèmes (donc la sécurité), en plus d'être plus simple à gérer côté applicatif (plus de certitudes, donc moins de bugs)., _(*6)

Les échanges se font en JSON et nous suivons les codes HTTP standards., _(*7)

Requête

En tant qu'architecture REST, les échanges sont sans-état, ce qui signifie que le serveur ne stocke pas d'information pour se souvenir d'un client et n'induit rien. Cela implique que le client doit fournir toutes les informations nécessaires à la réalisation d'une action, passant tout d'abord par une connexion, puis la transmission à chaque requête du token reçu suite à cette connexion., _(*8)

Les headers basiques, à transmettre pour toute requête, sont :, _(*9)

Content-Type: application/json
Accept: application/json

Première requête

Afin de vérifier que l'installation de l'API s'est bien déroulée, nous avons mis en place une route sans authentification :, _(*10)

GET /hello_world

Authentification

L'authentification s'appuie sur la méthode Basic Access :, _(*11)

GET /authentification
Authorization: Basic {base64(login:mot_de_passe)}

Si l'utilisateur existe et a le droit de se connecter, l'API enverra le token d'identification, dont la durée de validité est de 30min (repoussée à chaque échange)., _(*12)

Échanges authentifiés

Une fois connecté, tous les échanges devront avoir le header :, _(*13)

Token: {token}

Requêtes avec données

Lors d'un ordre avec données (POST | PUT), le corps de la requête doit ressembler à :, _(*14)

{
    "propriété1": "valeur1",
    "propriétéN": "valeurN"
}

Réponse

Les réponses de l'API se font sous la spécification jsend. Autrement dit :, _(*15)

{
    "code": "codeHTTP",
    "status": "typeDeReponse",
    "message": "messageCorrespondantAuCode",
    "data": "donnéesDeRéponse"
}

Routes disponibles

Voir Swagger pour une documentation exhaustive., _(*16)

Versions

L'API suit semver, ce qui signifie qu'une route ne sera enlevée ou que ses spécifications ne seront changées que si la version passe vM.0.0. Autrement, il n'y aura pas de cassages de compatibilité ., _(*17)

The Versions

31/07 2018

library api

libertempo/api

The README.md

libertempo-api

Panthéon

API Libertempo

Initialisation

Requête

Première requête

Authentification

Échanges authentifiés

Requêtes avec données

Réponse

Routes disponibles

Versions

The Versions

dev-ws/heure

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

dev-pry/typeSupprimable

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

dev-master

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

dev-pry/noCo

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

v1.1.0

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

v1.0.0

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

v0.7.0

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

v0.6.0

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

0.5.0

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

0.3.2

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

0.3.1

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

0.4.0

The Requires

The Development Requires

by Prytoegrian

by wouldsmina

0.3.0

The Requires

by Prytoegrian

by wouldsmina