Références API

Introduction


Toutes les demandes d'API de production sont effectuées pour :

https://api.concierge.eu

Certains de nos points d'accès API requièrent des informations d'identification OAuth 2.0. Consultez le guide d'authentification et d'autorisation pour commencer.

Ensuite, votre application client demande un access_token à partir du serveur d'autorisation Concierge, récupérez cet access_token à partir de la réponse et envoyez le dans votre header lors de vos appels à l'api Concierge.


REST

L'API Concierge est une API RESTFULL. Cela signifie que l'API est conçue pour vous permettre d'obtenir, créer, mettre à jour et supprimer des objets avec les verbes HTTP GET, POST, PUT, PATCH et DELETE.


JSON

L'API de Concierge communique exclusivement dans JSON. Cela signifie que vous devez toujours définir l'en-tête Content-Type en application/json pour vous assurer que vos requêtes soient correctement acceptées et traitées par l'API.


GET User


Profil utilisateur

Retourne des informations sur l'utilisateur Concierge autorisé.


Ressource

 GET /user 

Autorisation

OAuth 2.0 bearer token avec le scope read_user


Paramètres de requête

Aucun


Exemple de requête

https://api.concierge.eu/user

Réponse

Status-code: 200 OK


{
  "id": "2dcb7063-c25a-413e-ab26-8526c34c27a0",
  "firstname": "John",
  "lastname": "Doe",
  "avatar_url": "avatar/2dcb7063-c25a-413e-ab26-8526c34c37a0.jpeg",
  "gender": 1,
  "email": "nicolas@concierge.eu",
  "email_confirmed": true,
  "creation_date": "2017-01-04T09:51:05.993",
  "update_date": "2017-03-06T14:36:02.72"
}

Nom Description
id Identifiant unique de l'utilisateur
firstname Prénom de l'utilisateur
lastname Nom de l'utilisateur
avatar_url Url de l'avatar de l'utilisateur
gender Sexe de l'utilisateur (0 : non défini, 1 : Homme, 2 : Femme)
email Adresse mail de l'utilisateur
email_confirmed Adresse email confirmée en cliquant sur le lien reçu par email
creation_date Date de création du compte utilisateur
update_date Date de la dernière modification du compte utilisateur
get_concierges

GET Concierges


Liste des concierges

Retourne la liste des concierges dont l'utilisateur est le propriétaire.


Ressource

 GET /concierges 

Autorisation

OAuth 2.0 bearer token avec le scope read_concierge


Paramètres de requête

Aucun


Exemple de requête

https://api.concierge.eu/concierges

Réponse

Status-code: 200 OK


[
  {
    "id": "49bb39f3-d3be-4597-a47e-12ab40c502a1",
    "name": "Alfred",
    "place": "Home",
    "version": "1.0.1",
    "last_connection": "2017-03-14T09:47:04.823",
    "active": true,
    "connected": true,
    "reference": "3938312330365119002a0030",
    "latitude": 49.54717,
    "longitude": 0.045908,
    "sound": true
  }
]

Nom Description
id Identifiant unique du concierge
name Libellé du concierge
place Emplacement où le concierge est installé
version Version actuelle du concierge
last_connection Date et heure de la dernière connexion du concierge au cloud
active Etat du concierge (true : utilisateur absent, false : utilisateur présent)
connected Etat de connexion du concierge au cloud
reference Référence matériel du concierge
latitude Latitude de la localisation du concierge
longitude Longitude de la localisation du concierge
sound Etat du son sur le concierge


GET Concierges/{concierge_id}


Récupération d'un concierge

Retourne le concierge dont l'utilisateur est le propriétaire, spécifié par son identifiant.


Ressource

 GET /concierges/{concierge_id} 

Autorisation

OAuth 2.0 bearer token avec le scope read_concierge


Paramètres de requête

Nom Type Description
concierge_id string Identifiant unique du concierge

Exemple de requête

https://api.concierge.eu/concierges/49bb39f3-d3be-4597-a47e-12ab40c502a1

Réponse

Status-code: 200 OK


[
  {
    "id": "49bb39f3-d3be-4597-a47e-12ab40c502a1",
    "name": "Alfred",
    "place": "Home",
    "version": "1.0.1",
    "last_connection": "2017-03-14T09:47:04.823",
    "active": true,
    "connected": true,
    "reference": "3938312330365119002a0030",
    "latitude": 49.54717,
    "longitude": 0.045908,
    "sound": true
  }
]

Nom Description
id Identifiant unique du concierge
name Libellé du concierge
place Emplacement où le concierge est installé
version Version actuelle du concierge
last_connection Date et heure de la dernière connexion du concierge au cloud
active Etat du concierge (true : utilisateur absent, false : utilisateur présent)
connected Etat de connexion du concierge au cloud
reference Référence matériel du concierge
latitude Latitude de la localisation du concierge
longitude Longitude de la localisation du concierge
sound Etat du son sur le concierge


PUT Concierges/{concierge_id}


Modification d'un concierge

Permet la modification d'un concierge dont l'utilisateur est le propriétaire, spécifié par son identifiant.


Ressource

 PUT /concierges/{concierge_id} 

Autorisation

OAuth 2.0 bearer token avec le scope write_concierge


Paramètres de requete

{
"name": "Genesis",
"place": "Kitchen",
"active": true,
"sound": false
}

Nom Type Description
name (optionnel) string Libelle du concierge
place (optionnel) string Emplacement où le concierge est installé
active (optionnel) bool Etat du concierge (true : utilisateur absent, false : utilisateur present)
sound (optionnel) bool Etat du son sur le concierge

Tous les paramètres inclus dans le JSON sont optionnels, si vous voulez juste modifier l'activation du concierge, vous pouvez ne pas préciser les autres paramètres.


Exemple de requête

https://api.concierge.eu/concierge/49bb39f3-d3be-4597-a47e-12ab40c502a1

Réponse

Status-code: 204 No Content