NAV
shell

Bienvenue sur la doc de nos API (BETA)

Retrouvez nos exemples sur ce côté de la page

# Ces exemples sont faits avec CURL

Vous pouvez proposer dès à présent notre service à vos utilisateurs en intégrant nos API.

Enrichissez votre application grâce à nos API mises à jour en temps réel.

Pour utiliser nos API, contactez-nous à l’adresse suivante contact@elocky.com

Après étude de votre demande, un mail sera envoyé à votre adresse afin de vous transmettre votre « Client ID » et « Client Secret ».

Ces informations vous permettront de générer un « Access Token » et de vous identifier pour utiliser nos API.

Authentification API

Authentification anonyme

Pour obtenir votre "access token", utilisez ce code :

     
         # Obtention de l'access token
          curl -d "client_id=xxxxx&client_secret=yyyyy&grant_type=client_credentials"
         https://www.elocky.com/oauth/v2/token
     

Remplacez xxxxx par votre "Client Id" et yyyyy par votre "Client Secret".

     
         # Exemple de retour en JSON
     
     
         {
         "access_token":YzRhNDFlNmJmNzE3MTRmODk2OGQ5ODUyZWY4MWRiM2JhMTFkNjMxOGZjMWQ1,
         "expires_in": "3600",
         "token_type": "bearer",
         "scope": null,
         }
     
     
         # Exemple d'access token expiré
     
    
        {
        "error":"invalid_grant",
        "error_description":"The access token provided has expired."
        }
     

L'authentification anonyme vous permet d'utiliser les API qui ne sont liés à aucun utilisateur.

Requête HTTP

GET https://www.elocky.com/oauth/v2/token?client_id=xxxxx&client_secret=yyyyy&grant_type=client_credentials

URL Parameters

Nom Obligatoire Description
client_id OUI xxxxx
client_secret OUI yyyyy
grant_type OUI client_credentials

Retour API

Nom Type Description
access_token string
expires_in integer Validité de l'access token en secondes
token_type string
scope NULL

Authentification Utilisateur

Pour obtenir votre "access token" d'utilisateur authentifié, utilisez ce code :

    
        # Obtention de l'access token d'utilisateur authentifié
        curl -d "client_id=xxxxx&client_secret=yyyyy&grant_type=password&username=email&password=mdp"
        -X POST https://www.elocky.com/oauth/v2/token
    

Remplacez xxxxx par votre "Client Id" et yyyyy par votre "Client Secret" ainsi que l'email et le mot de passe de l'utilisateur.

    
        # Exemple de retour en JSON
    
    
        {
        "access_token":YzRhNDFlNmJmNzE3MTRmODk2OGQ5ODUyZWY4MWRiM2JhMTFkNjMxOGZjMWQ1,
        "expires_in": "3600",
        "token_type": "bearer",
        "scope": null,
        "refresh_token": 5ODUyZWY4MWRiM2JhMTFkNjMxOGZjMWQ1YzRhNDFlNmJmNzE3MTRmODk2OGQ,
        }
    
    
        # Exemple d'access token expiré
    
    
        {
        "error":"invalid_grant",
        "error_description":"The access token provided has expired."
        }
    

La génération « d'Access Token » pour un utilisateur est quasiment la même chose que pour l'Access Token anonyme. Cela vous permettra d'utiliser nos API destinés à un utilisateur connecté.

Requête HTTP

POST https://www.elocky.com/oauth/v2/token

REQUIREMENTS

Nom Obligatoire Description
client_id OUI xxxxx
client_secret OUI yyyyy
grant_type OUI password
username OUI email utilisateur
password OUI password utilisateur

Retour API

Nom Type Description
access_token string
expires_in integer Validité de l'access token en secondes
token_type string
scope NULL
refresh_token string

Refresh Token Utilisateur

Pour rafréchir votre "access token" d'utilisateur authentifié, utilisez ce code :

    
        # Obtention de l'access token d'utilisateur authentifié
        curl -d "client_id=xxxxx&client_secret=yyyyy&grant_type=refresh_token&refresh_token=zzzzz"
        -X POST https://www.elocky.com/oauth/v2/token
    

Remplacez xxxxx par votre "Client Id" et yyyyy par votre "Client Secret" ainsi que zzzzz par votre "Refresh Token".

    
        # Exemple de retour en JSON
    
    
        {
        "access_token":YzRhNDFlNmJmNzE3MTRmODk2OGQ5ODUyZWY4MWRiM2JhMTFkNjMxOGZjMWQ1,
        "expires_in": "3600",
        "token_type": "bearer",
        "scope": null,
        "refresh_token": 5ODUyZWY4MWRiM2JhMTFkNjMxOGZjMWQ1YzRhNDFlNmJmNzE3MTRmODk2OGQ,
        }
    
    
        # Exemple d'access token expiré
    
    
        {
        "error":"invalid_grant",
        "error_description":"The access token provided has expired."
        }
    

Le Refresh de « l'Access Token » d'un utilisateur permettra d'obtenir un nouvel Access Token lorsque le précédant a expiré.

Requête HTTP

POST https://www.elocky.com/oauth/v2/token

REQUIREMENTS

Nom Obligatoire Description
client_id OUI xxxxx
client_secret OUI yyyyy
grant_type OUI refresh_token
refresh_token OUI zzzzz

Retour API

Nom Type Description
access_token string
expires_in integer Validité de l'access token en secondes
token_type string
scope NULL
refresh_token string

Gestion des utilisateurs

Créer un profil utilisateur

Pour créer un profil utilisateur Elocky, utilisez ce code :

    
        curl -X POST -d "firstName={firstName}&lastName={lastName}&phone={625131568}&phoneCode={+33}&email={email}&password={password}" https://www.elocky.com/webservice/user/.json?access_token={token}
    

Remplacez {token} par votre "Access Token" {firstName} par le prénom de l'utilisateur à enregistrer, {lastName} par son nom, {625131568}par son numéro de téléphone et {+33} pour le numéro indicatif de son pays de résidence. Changez aussi {email} pour l'adresse email que vous souhaitez lier au compte ainsi que {password} pour le mot de passe de ce dernier.

La requête retourne la référence de l'utilisateur créé en cas de réussite.

Ici, vous pouvez créer un profil utilisateur Elocky.

Requête HTTP

POST https://www.elocky.com/webservice/user/.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
firstName OUI Prénom
lastName OUI Nom
phone OUI Numéro de téléphone
phoneCode OUI Indicatif du pays
email OUI Adresse email d'inscription
password OUI Mot de passe du compte

Demande de réinitialisation de mot de passe

Pour effectuer une demande de réinitilisation de mot de passe lié à un compte utilisateur Elocky, utilisez ce code :

    
        curl -X POST -d "email={email}" https://www.elocky.com/webservice/user/reset-password.json?access_token={token}
    

Remplacez {token} par votre "Access Token" et {email} par l'adresse email du compte Elocky.

La requête retourne "success" en cas de réussite.

Ici, vous pouvez réinitiliser le mot de passe d'un compte Elocky. Un mail sera envoyé à l'utilisateur en question avec un lien pour définir un nouveau mot de passe pour son compte.

Requête HTTP

POST https://www.elocky.com/webservice/user/reset-password.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
email OUI Adresse email du compte

Modifier le profil utilisateur

Pour modifier votre profil utilisateur Elocky, utilisez ce code :

    
        curl -X PUT -d "firstName={firstName}&lastName={lastName}&phone={XXXXXXXXXX}&email={email}" https://www.elocky.com/webservice/user/.json?access_token={token}
    

Remplacez {token} par votre "Access Token" {firstName} par le prénom de l'utilisateur, {lastName} par son nom, {XXXXXXXXXX}par son numéro de téléphone et {email} pour l'adresse email que vous souhaitez lier au compte.

La requête retourne "success" en cas de réussite.

Ici, vous pouvez modifier votre profil utilisateur Elocky.

Requête HTTP

PUT https://www.elocky.com/webservice/user/.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
firstName OUI Prénom
lastName OUI Nom
phone OUI Numéro de téléphone
email OUI Adresse email d'inscription

Récupérer données profile

Pour récupérer un profil utilisateur Elocky, utilisez ce code :

    
        curl  https://www.elocky.com/webservice/user/.json?access_token={token}
    

Remplacez {token} par votre "Access Token"

     
         # Exemple de retour en JSON
     
     
         {
         "id": 1,
         "reference": 575ffbc1132c9,
         "created": 2015-12-14T12:48:58+0100,
         "state": 1,
         "email": contact@elocky.com,
         "first_name": david,
         "last_name": billiere,
         "photo": 44e40ddfed81e8b70c8defbc798c5ff46f9173cb.jpeg,
         "phone": +33 667850050
         }
     

Ici, vous pouvez récupérer un profil utilisateur Elocky.

Requête HTTP

GET https://www.elocky.com/webservice/user/.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Modifier le password

Pour modifier votre mot de passe utilisateur Elocky, utilisez ce code :

    
        curl -X PUT -d "password={password}&old_password={old_password}" https://www.elocky.com/webservice/user/change-password.json?access_token={token}
    

Remplacez {token} par votre "Access Token" {password} par le nouveau password de l'utilisateur, {old_password} par l'ancien password de l'utilisateur

La requête retourne "success" en cas de réussite.

Ici, vous pouvez modifier votre mot de passe utilisateur Elocky.

Requête HTTP

PUT https://www.elocky.com/webservice/user/change-password.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
password OUI password
old_password OUI old_password

Récupérer photo profile

Pour télécharger une photo de profile utilisateur Elocky, utilisez ce code :

    
        curl https://www.elocky.com/webservice/user/photo/{name}/download.json?access_token={token}
    

Remplacez {token} par votre "Access Token" et {name} par le nom de la photo

La requête retourne la photo en cas de réussite.

Ici, vous pouvez télécharger la photo de profile d'un utilisateur Elocky.

Requête HTTP

GET https://www.elocky.com/webservice/user/photo/{name}/download.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
name OUI namePhoto.jpg

Modifier photo profile (soon)

Gestion des lieux

Créer une nouvelle adresse

Pour pouvoir créer une nouvelle adresse, utilisez ce code :

    
        curl -X POST -d "name={name}&address={address}&city={city}&zipcode={zipcode}&country={countryId}&complement={complement}&timezone={timezoneId}" https://www.elocky.com/webservice/address/new.json?access_token={token}
    

Remplacez {token} par votre "Access Token" et {id} par l'identifiant du lieu à modifier. La requête retournera l'ID du lieu nouvellement créé en cas de réussite.

Cette api permet d'enregistrer un nouveau lieu. Pour définir les paramètres de la requête, il sera nécessaire de récupérer les données de l'api de liste des pays et fuseaux horaires.

Requête HTTP

POST https://www.elocky.com/webservice/address/new.json?access_token={token}

URL Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
name OUI Nom du lieu
address OUI Adresse du lieu
city OUI Ville
zipcode OUI Code postal
country(id) OUI Identifiant du Pays
timezone(id) OUI Identifiant du fuseau horaire
complement non Complément d'adresse

Liste des pays et fuseaux horaires

Pour obtenir la liste des pays et des fuseaux horaires, utilisez ce code :

    curl https://www.elocky.com/webservice/address/country.json?access_token={token}

Remplacez {token} par votre "Access Token". Vous pouvez utiliser cette api de façon anonyme.

Cette api permet de récupérer un liste de pays et de fuseaux horaires. Chacun est relié à un ID qui sera nécessaire à d'autres api.

Requête HTTP

GET https://www.elocky.com/webservice/address/country.json?access_token={token}

URL Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Liste des lieux liés à un utilisateur

Pour obtenir l'historique d'un lieu, utilisez ce code :

    
        curl https://www.elocky.com/webservice/address/list.json?access_token={token}
    

Remplacez {token} par votre "Access Token"

                    
	{
		"lieux":[
    		{
            	"coords":[]
            	"id":2,
            	"address":"45 rue sainte colombe",
            	"zip_code":33000,
            	"city":"Bordeaux",
            	"check_in":"1970-01-01 17:19:00",
            	"check_out":"1970-01-01 19:24:00",
            	"check_bool": 1,
            	"board": [
            		 {
            			"id":1,
            			"name":"Serrure dev",
            			"type_board": {
            				"id":1,
            			},
            			"alarm":1,
            		},
            		{
            			"id":3,
            			"name":"Fenetre ELOCKY",
            			"type_board": {
            				"id":2
            			},
            			"alarm":0,
            		}
            	],
            	"passerelle":[
            		{
            			"id": 345,
            		},
            		{
            			"id": 286
            		},
            	"country":{
            		"id":75,
            		"name":"France",
            	},
            	"admin_address":[
            		"state":1,
			"name":"Elocky Dev",
			"email":"fvallortigara@gmail.com",
			"firstName":"Franck",
			"lastName":"Vallortigara",
			"photo":"profil.jpg"
            	],
            	"alarm":1,
            	"photo":"542410a7885fe768da48fc07d00cc75d1e132f23.jpeg",
            	"timezone":{
            		"id": 576,
            		"name": "Europe/Paris",
            	 }
    		}
		]
	}

                    
                

Récupérer la liste des lieux liés à un utilisateur Elocky.

Requête HTTP

GET https://www.elocky.com/webservice/address/list/.json?access_token={token}

URL Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Retour API

Nom Type Description
coords integer Coordonnées géographiques du lieux
id integer Identifiant du lieux
zip_code string Code postal
city string Ville
check_in string Horaire d'entrée par defaut
check_out string Horaire de sortie par defaut
check_bool integer Horaire par defaut activées
alarm int Alarme activée
photo string File name
Board
id integer Identidiant de l'objet
name string Nom de l'objet
type_board(id) integer Type d'objet
alarm integer Etat de l'alarme
passerelle(id) integer Identifiant passerelle
Country
id integer Identifiant pays
name string Nom pays
admin_address
id integer Identifiant admin address
user_reference string Référence de l'administrateur
state integer Etat de l'administrateur
name string Nom de l'admin address
email string Email de l'administrateur
firstName string Prénom de l'administrateur
lastName string Nom de l'administrateur
photo string Photo de l'administrateur
timezone
id integer Identifiant timezone
name string Nom timezone

Valeurs type_board en fonction de l'id

id name
1 Serrure
2 Capteur d'intrusion beacon
3 Camera
4 Gache électrique

Modifier les informations d'un lieu

Pour pouvoir modifier les données d'une adresse, utilisez ce code :

curl -X PUT -d "name={name}&address={address}&city={city}&zipcode={zipcode}&country={countryId}&complement={complement}&timezone={timezoneId}" https://www.elocky.com/webservice/address/edit/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" et {id} par l'identifiant du lieu à modifier. La requête retournera "success" en cas de réussite.

Cette api permet de modifier les données d'un lieu existant d'après son ID. Pour définir les paramètres de la requête, il sera nécessaire de récupérer les données de l'api de liste des pays et fuseaux horaires.

Requête HTTP

PUT https://www.elocky.com/webservice/address/edit/{id}.json?access_token={token}

URL Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
name OUI Nom du lieu
address OUI Adresse du lieu
city OUI Ville
zipcode OUI Code postal
country(id) OUI Identifiant du Pays
timezone(id) OUI Identifiant du fuseau horaire
complement non Complément d'adresse

Historique d'un lieu

Pour obtenir l'historique d'un lieu, utilisez ce code :

curl https://www.elocky.com/webservice/address/log/{id}/{start}.json?access_token={token}

Remplacez {token} par votre "Access Token"et {id} par l'identifiant du lieu.

L'historique est renvoyé sous forme de jeux de 30 résultats. Remplacez {start} par le nombre correspondant au premier résultat que vous souhaitez prendre en compte. "1" Renvoie le dernier log et les 29 précédents, "2" l'avant dernier résultat et les 29 précédents et ainsi de suite

                    
                        [
                        "total":368
                        {
                        "id":1,
                        "created":2017-07-31T17:50:03+02:00,
                        "type":3,
                        "state":2,
                        "firstName":John,
                        "lastName":Doe,
                        "photo":profil.jpg,
                        "id_board":134,
                        "id_board_access":25,
                        },
                        {
                        "id": 2,
                        "created":2017-01-26T17:36:40+01:00,
                        "type":1,
                        "state":60,
                        },
                        ]
                    
                

Récupérer l'historique des logs sur un lieu.

Requête HTTP

GET https://www.elocky.com/webservice/address/log/{id}/{start}.json?access_token={token}

URL Parameters

+
Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
id OUI Identifiant du lieu : 1
startOUI 1er log pris en compte

Retour API

Nom Type Description
total integer Nombre total de logs
id integer Identifiant du log
creates DateTime Date de création du log
type integer Type du log
state integer Etat du log
firstName string Prénom de l'utilisateur
lastName string Nom de l'utilisateur
id_board integer Identifiant du Board
id_board_access integer Identifiant du Board Access
photo File (image) Image de l'utilisateur

Valeurs type et state

La valeur du type influe aussi sur celle de l'état (state).

Type Valeur type State Valeur state
0 Passerelle 3 Ajout passerelle
1 Serrure 2 Elocky admin
1 Serrure 3 Ajout serrure
1 Serrure 80 MAJ serrure
2 Beacon 3 Ajout beacon
3 Accès 2 Notification d'ouverture
3 Accès 3 Ajout d'accès
3 Accès 10 Reboot
3 Accès 11 Reset
3 Accès 12 Déconfiguration
3 Accès 13 Configuration
3 Accès 14 Sleep normal
3 Accès 15 Sleep soft
3 Accès 16 Sleep deep
3 Accès 17 Wake up normal
3 Accès 18 Wake up soft
3 Accès 19 Wake up deep
3 Accès 60 Update software
3 Accès 99 Debug

Supprimer un log

Pour supprimer un log, utilisez ce code :

curl -X DELETE https://www.elocky.com/webservice/address/log/delete/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" et {id} par l'identifiant du log.

La requête retourne "success" en cas de réussite.

Ici, vous pouvez supprimer un log d'accès à un lieu.

Requête HTTP

DELETE https://www.elocky.com/webservice/address/log/delete/{id}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
id OUI Identifiant du log

Récupérer photo address

Pour télécharger une photo de lieu Elocky, utilisez ce code :

    
        curl https://www.elocky.com/webservice/address/photo/{name}/download.json?access_token={token}
    

Remplacez {token} par votre "Access Token" et {name} par le nom de la photo

La requête retourne la photo en cas de réussite.

Ici, vous pouvez télécharger la photo d'un lieu Elocky.

Requête HTTP

GET https://www.elocky.com/webservice/address/photo/{name}/download.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
name OUI namePhoto.jpg

Modifier photo address (soon)

Supprimer address (soon)

Activer/Désactiver l'alarme (soon)

Liste des utilisateurs du lieu (soon)

Modifier le type d'un utilisateur (soon)

Supprimer un utilisateur du lieu (soon)

Gestion des objets

Liste des objets liés à un lieu

Pour obtenir la liste d'objets connectés à un lieu, utilisez ce code :

curl https://www.elocky.com/webservice/address/object/{reference}/{idAddress}.json?access_token={token}

Remplacez {reference} par la référence de l'administrateur du lieu, {idAddress} par l'identifiant du lieu et {token} par votre "Access Token"

                    
                        [
                        {
                        	"board":[
                        	  {
                        		"nbAccess":2,
                        		"id":455,
                        		"name":"Serrure dev",
                        		"type_board":{,
                        			"id":1,
                        		},
                        		"battery":90,
                        		"tension":3586,
                        		"maj":1,
                        		"date_battery":"2017-06-04T00:00:00+02:00",
                        	  },
                        	  {
                        		"nbAccess":0,
                        		"id":266,
                        		"name":"Fenetre ELOCKY",
                        		"type_board":{,
                        			"id":2,
                        		},
                        		"battery":-45,
                        		"data":"29",
                        		"veille":0
                        	  }
                        	"passerelle":[
                        	  {
                        		"nbObject":2,
                        		"id":23,
                        		"name":"passerelle dev 2",
                        		"state":1
                        	  },
                        	  {
                        		"nbObject":1,
                        		"id":19,
                        		"name":"passerelle dev 1",
                        		"state":1
                        	  }
                        	}
                        	]

                    
                

Récupérer la liste des objets liés à une addresse.

Requête HTTP

GET https://www.elocky.com/webservice/address/object/{reference}/{idAddress}.json?access_token={token}

URL Parameters

Nom Obligatoire Description
reference OUI Référence de l'administrateur du lieu
idAddress OUI Identifiant de l'adresse
access_token OUI Token d'authentication pour l'api

Retour API

Nom Type Description
board
nbAccess integer Nombre d'accès par serrure
id integer Identifiant de l'objet
name string Nom de l'objet
battery integer Niveau de batterie
tension integer Niveau de tension
data string Température pour les beacons
veille integer Etat de veille de l'objet
maj integer Etat de mise à jour de l'objet
date_battery date Date d'installation de la batterie
reference string Référence de l'objet
version string Version de l'objet
programme integer Programme de l'objet
reveille integer Degré de sensibilité
connection integer Connexion de l'objet
type_board(id) integer Type d'objet
passerelle
nbObject integer Nombre d'objets liés à la passerelle
id integer Identidiant de la passerelle
name string Nom de la passerelle
vpn string VPN
connectionInternet integer Etat connexion internet
maj integer Mise à jour
connection integer Connexion
reference string Référence de la passerelle
version string Version de la passerelle
address_ip_local string Adresse IP locale
address_ip string Adresse IP
state integer Etat de la passerelle

Valeurs type_board en fonction de l'id

id name
1 Serrure
2 Capteur d'intrusion beacon
3 Camera
4 Gache électrique

Supprimer un objet (soon)

Déclencher l'ouverture à distance (soon)

Modifier les information d'un objet (soon)

Modifier les information d'une box (soon)

Supprimer une box (soon)

Fonctions objets distance (soon)

Fonctions box distance (soon)

Gestion des accès

Liste des accès liés à un utilisateur

Pour obtenir la liste des accès, utilisez ce code :

curl https://www.elocky.com/webservice/access/list/user.json?access_token={token}

Remplacez {token} par votre "Access Token"

        
            "access":[
            {
            	"id":19,
            	"created":"2016-06-14T00:00:00+02:00",
            	"name":"Mon accès",
            	"user_reference":"575ffbc1332c9",
            	"access_exep":[
            		{
            			"id":19,
            			"start":"2017-01-16T08:00:00+01:00",
            			"stop":"2017-01-16T12:00:00+01:00",
            			"is_dispo":1
            			},
            			{
            			"start":"2017-01-16T19:30:00+01:00",
            			"stop":"2017-01-16T22:00:00+01:00",
            			"is_dispo":1
            			}
            		}
            	],
            	"acces_recu":[
            		{
            			"id":20,
            			"start":"08:00:00",
            			"stop":"16:00:00",
            			"state":1,
            			"day":{,
            				"id":1,
            				"stop":"mardi"
            			},
            		}
            	],
            	"board": [
            		"id":9,
            		"name":"Serrure dev",
            		"address":{
            			"id":2,
            			"address":"45 rue sainte colombe",
            			"zip_code":"33000",
            			"city":"Bordeaux",
            			"country":{,
            				"id":75,
            				"address":"France"
            			},
            			"admin_address":[,
            				{
						"id":49
						"user_reference":"575ffbc1332c9",
            					"state":1,
            					"name":"Elocky Dev",
            					"email":"fvallortigara@gmail.com",
            					"firstName":"Franck",
            					"lastName":"Vallortigara",
            					"photo":"profil.jpg"
            				},
            				{
						"id":10
						"user_reference":"586b85b00cb31",
            					"state":0,
            					"name":"Elocky Dev",
            					"email":"david.billiere@viacesi.fr",
            					"firstName":"David",
            					"lastName":"Billiere",
            					"photo":"david.jpg"
            				}
            			],
            			"photo":"elocky.jpg"
            		]
            	},
            	"type_access":{
            		"id":1
            	}
            	"email":"david.billiere@viacesi.fr",
            	"firstName":"David",
            	"lastName":"Billiere",
            	"photo":"david.jpg"
            }
            ]
        
                

Récupérer la liste des accès liés à un utilisateur Elocky.

Requête HTTP

GET https://www.elocky.com/webservice/access/list/user.json?access_token={token}

URL Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Retour API

Nom Type Description
id integer Identifiant de l'accès
created date Date de création de l'accès
name string Nom de l'accès
user_reference string Référence du créateur de l'accès
email string Email du créateur de l'accès
firstName string Prénom du créateur de l'accès
lastName string Nom du créateur de l'accès
photo string Photo du créateur de l'accès
type_access(id) integer Identifiant du type d'accès
favorite_access(id) integer Identifiant de l'accès favori
favorite_access(name) string Nom de l'accès favori
access_exep
id integer Identifiant de l'accès exeptionnel
start date Date début accès exeptionnel
stop date Date début accès exeptionnel
is_dispo integer Interdiction/Autorisation d'accès à la date choisie
access_recu
id integer Identifiant de l'accès récurent
start date Horaire début accès récurent
stop date Horaire début accès récurent
state integer Interdiction/Autorisation d'accès à l'horaire choisie
day(id) integer Identifiant du jour de l'accès récurent
day(name) string Nom du jour de l'accès récurent
board
name string Nom de l'objet
address
id integer Identifiant du lieu
address string Adresse du lieu
zip_code string Code postal du lieu
city string Ville du lieu
photo string Image liée au lieu
country(id) integer Identifiant du Pays
country(name) string Nom du Pays
admin_address
id integer Identifiant admin address
user_reference string Référence de l'administrateur
state integer Etat de l'administrateur
name string Nom de l'admin address
email string Email de l'administrateur
firstName string Prénom de l'administrateur
lastName string Nom de l'administrateur
photo string Photo de l'administrateur

Valeurs type_access en fonction de l'id

id name
1 Administrateur
2 Modérateur
3 Utilisateur
4 Invité
4 Code mail/sms
4 Carte RFID

Liste utilisateurs invités à un accès

Pour obtenir la liste des invités sur un accès, utilisez ce code :

curl https://www.elocky.com/webservice/access/list/invite.json?access_token={token}

Remplacez {token} par votre "Access Token"

        
            "access":[
            {
            	"id":122,
            	"user_reference":"575ffbc1332c9",
            	"access_exep":[
            		{
            			"id":18,
            			"start":"2017-01-16T08:00:00+01:00",
            			"stop":"2017-01-16T12:00:00+01:00",
            			"is_dispo":1
            			},
            			{
            			"start":"2017-01-16T19:30:00+01:00",
            			"stop":"2017-01-16T22:00:00+01:00",
            			"is_dispo":1
            			}
            		}
            	],
            	"acces_recu":[
            		{
            			"id":9,
            			"start":"08:00:00",
            			"stop":"16:00:00",
            			"state":1,
            			"day":{
            				"id":1,
            				"stop":"mardi"
            			}
            		}
            	],
            	"board": [
            		"id":9,
            		"name":"Serrure dev",
            		"address":{
            			"id":2,
            			"address":"45 rue sainte colombe",
            			"zip_code":"33000",
            			"city":"Bordeaux",
            			"country":{,
            				"id":75,
            				"address":"France"
            			},
            			"admin_address":[
            				{
            					"name":"Elocky Dev",
            				}
            			],
            			"photo":"elocky.jpg"
            		]
            	},
            	"type_access":{
            		"id":1
            	}
            	"firstName":"David",
            	"lastName":"Billiere",
            	"email":"david.billiere@viacesi.fr",
            	"photo":"david.jpg"
            }
            ]
        
                

Récupérer la liste des invités liés à un accès.

Requête HTTP

GET https://www.elocky.com/webservice/access/list/invite.json?access_token={token}

URL Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Retour API

Nom Type Description
id integer Identifiant de l'accès
user_reference string Référence du créateur de l'accès
email string Email du créateur de l'accès
firstName string Prénom du créateur de l'accès
lastName string Nom du créateur de l'accès
photo string Photo du créateur de l'accès
type_access(id) integer Identifiant du type d'accès
access_exep
id integer Identifiant de l'accès exeptionnel
start date Date début accès exeptionnel
stop date Date début accès exeptionnel
is_dispo integer Interdiction/Autorisation d'accès à la date choisie
access_recu
id integer Identifiant de l'accès récurent
start date Horaire début accès récurent
stop date Horaire début accès récurent
state integer Interdiction/Autorisation d'accès à l'horaire choisie
day(id) integer Identifiant du jour de l'accès récurent
day(name) string Nom du jour de l'accès récurent
board
id integer Identifiant de l'objet
name string Nom de l'objet
address
id integer Identifiant du lieu
address string Adresse du lieu
zip_code string Code postal du lieu
city string Ville du lieu
photo string Image liée au lieu
country(id) integer Identifiant du Pays
country(name) string Nom du Pays
admin_address
name string Nom de l'admin address

Valeurs type_access en fonction de l'id

id name
1 Administrateur
2 Modérateur
3 Utilisateur
4 Invité
4 Code mail/sms
4 Carte RFID

Créer un nouvel accès

Pour établir un nouvel accès, utilisez ce code :

curl -d "referenceInvite=AAAA&board=BBBB&typeAccess=CCCC&nameAccess=DDDD" https://www.elocky.com/webservice/access/new.json?access_token={token}

Remplacez {token} par votre "Access Token" AAAA par l'addresse email de l'utilisateur que vous souhaitez ajouter (s'il est déjà utilisateur Elocky), BBBB par l'identifiant de l'objet, CCCCpar le type d'accès (se référer au tableau des valeurs de type_access) et DDDD par le nom que vous souhaitez donner à l'accès.

Si l'utilisateur invité ne possède pas de compte Elocky, pensez à régler type_access sur 4 (invité) et ignorez la donnée referenceInvite

La requête retourne l'ID de l'accès créé

Créer un accès pour un utilisateur Elocky ou un invité. Si l'utilisateur invité possède un compte Elocky, veulliez renseigner son adresse email. Sinon, ignorez ce champ.

Requête HTTP

POST https://www.elocky.com/webservice/access/new.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api

Requirements

Nom Obligatoire Description
referenceInvite NON Référence de l'utilisateur invité
board OUI Identifiant de l'objet
TypeAccess OUI Type d'accès
nameAccess OUI Nom donné à l'accès

Valeurs type_access en fonction de l'id

id name
1 Administrateur
2 Modérateur
3 Utilisateur
4 Invité
5 Code mail/sms
6 Carte RFID

Créer un nouvel accès exeptionnel

Pour établir un nouvel accès, utilisez ce code :

curl -d "start={dateDebut}&stop={dateFin}&isDispo={X}" https://www.elocky.com/webservice/access/exep/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" {id} par l'identifiant de l'accès {dateDebut} par la date de début d'accès exeptionnel et {dateFin}par sa date de fin. Remplacez {X} par l'état souhaité sur l'accès (autorisé ou interdit).

La requête retourne l'ID de l'accès exeptionnel créé

Ici, vous pouvez créer un accès exeptionnel ou alors interdire l'accès à un utilisateur de façon temporaire

Requête HTTP

POST https://www.elocky.com/webservice/access/exep/{idAccess}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
idAccess OUI Identifiant de l'accès

Requirements

Nom Obligatoire Description
start OUI Date et horaire de début d'accès exeptionnel
stop OUI Date et horaire de fin d'accès exeptionnel
isDispo OUI Etat de l'accès à la date indiqué

Créer un nouvel accès récurent

Pour établir un nouvel accès récurent, utilisez ce code :

curl -d "start={dateDebut}&stop={dateFin}&day={X}" https://www.elocky.com/webservice/access/exep/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" {id} par l'identifiant de l'accès {dateDebut} par la date de début d'accès récurent et {dateFin}par sa date de fin. Remplacez {X} par l'identifiant du jour de l'accès récurent.

La requête retourne l'ID de l'accès récurent créé

Ici, vous pouvez créer un accès récurent selon le jour choisi

Requête HTTP

POST https://www.elocky.com/webservice/access/recu/{idAccess}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
idAccess OUI Identifiant de l'accès

Requirements

Nom Obligatoire Description
start OUI Date et horaire de début d'accès récurent
stop OUI Date et horaire de fin d'accès récurent
day OUI Identifiant du jour d'accès récurent

Valeurs de day en fonction de l'id

id name
1 Lundi
2 Mardi
3 Mercredi
4 Jeudi
5 Vendredi
6 Samedi
7 Dimanche

Créer un nouvel accès permanent

Pour établir un nouvel accès permanent, utilisez ce code :

curl -d "start={dateDebut}&stop={dateFin}" https://www.elocky.com/webservice/access/permanent/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" {id} par l'identifiant de l'accès {dateDebut} par la date de début d'accès permanent et {dateFin}par sa date de fin.

La requête retourne un tableau contenant la liste des id des 7 accès récurents créés

Ici, vous pouvez créer un accès permanent sur une période choisie.

Requête HTTP

POST https://www.elocky.com/webservice/access/recu/{idAccess}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
idAccess OUI Identifiant de l'accès

Requirements

Nom Obligatoire Description
start OUI Date et horaire de début d'accès permanent
stop OUI Date et horaire de fin d'accès permanent

Supprimer un accès exeptionnel

Pour supprimer accès exeptionnel, utilisez ce code :

curl -X DELETE https://www.elocky.com/webservice/access/exep/delete/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" et {id} par l'identifiant de l'accès exeptionnel.

La requête retourne "success" en cas de réussite.

Ici, vous pouvez supprimer un accès exeptionnel sur un lieu.

Requête HTTP

DELETE https://www.elocky.com/webservice/access/exep/delete/{id}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
id OUI Identifiant de l'accès exeptionnel

Supprimer un accès récurent

Pour supprimer accès récurent, utilisez ce code :

curl -X DELETE https://www.elocky.com/webservice/access/exep/delete/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" et {id} par l'identifiant de l'accès récurent.

La requête retourne "success" en cas de réussite.

Ici, vous pouvez supprimer un accès récurent sur un lieu.

Requête HTTP

DELETE https://www.elocky.com/webservice/access/recu/delete/{id}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
id OUI Identifiant de l'accès récurent

Modifier un accès existant

Pour modifier un accès permanent existant, utilisez ce code :

curl -X PUT -d "nameAccess={nameAccess}&typeAccess={idTypeAccess}" https://www.elocky.com/webservice/access/edit/{id}.json?access_token={token}

Remplacez {token} par votre "Access Token" {id} par l'identifiant de l'accès {nameAccess} par le nom que vous souhaitez donner à l'accès et {idTypeAccess}par l'identifier du type d'accès.

La requête retourne "success" en cas de réussite.

Ici, vous pouvez modifier les données d'un accès existant.

Requête HTTP

PUT https://www.elocky.com/webservice/access/edit/{id}.json?access_token={token}

Query Parameters

Nom Obligatoire Description
access_token OUI Token d'authentication pour l'api
id OUI Identifiant de l'accès

Requirements

Nom Obligatoire Description
nameAccess OUI Nom de l'accès
idTypeAccess OUI Identifiant du type d'accès

Valeurs type_access en fonction de l'id

id name
1 Administrateur
2 Modérateur
3 Utilisateur
4 Invité
5 Code mail/sms
6 Carte RFID

Supprimer un accès (soon)

Renouvellement d'un code invité (soon)

Codes erreurs

Code erreur Description
200 Returned when successful
400 Bad Request – Your request sucks
401 Unauthorized – Your API key is wrong
403 Forbidden – The kitten requested is hidden for administrators only
404 Not Found – The specified kitten could not be found
429 Too Many Requests – You’re requesting too many kittens! Slown down!
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarially offline for maintanance. Please try again later.