API Class Reference

Class API listant les méthodes appelées soit par GET via des URL respectant une architecture REST, soit par POST. Ces méthodes permettent d'accéder aux données de la base de données de l'application SOS Oxygène (iOS et Android). Toutes les données retournées sont encodées en JSON. La variable "api" correspond toujours au nom de la méthode appelée. La variable "key" lorsqu'elle est nécessaire doit correspondre à la chaîne suivante : MD5( ({idUtilisateur}*9 - 4)etuv!yi9{mdpUtilisateurCrypte} ) More...

Inheritance diagram for API:

Public Member Functions
	inscription ()
	motDePasseOublie ()
	connexion ()
	checkAutorisation ()
	arborescence ()
	synchro ()
	getContenu ()
	getProduit ()
	getModeVentilation ()
	addDevice ()
	autorizeNotifs ()
	json ($data)
	encodeArrayOfObjects ($array)
	processApi ()
Public Member Functions inherited from Rest
	get_referer ()
	response ($data, $status)
	get_request_method ()

Data Fields
	$phpMailer
Data Fields inherited from Rest
	$_allow = array()
	$_content_type = "application/json"
	$_request = array()
	$_user = null

Detailed Description

Class API listant les méthodes appelées soit par GET via des URL respectant une architecture REST, soit par POST. Ces méthodes permettent d'accéder aux données de la base de données de l'application SOS Oxygène (iOS et Android). Toutes les données retournées sont encodées en JSON. La variable "api" correspond toujours au nom de la méthode appelée. La variable "key" lorsqu'elle est nécessaire doit correspondre à la chaîne suivante : MD5( ({idUtilisateur}*9 - 4)etuv!yi9{mdpUtilisateurCrypte} )

Author

Sylvain Gascon - Vertuoz sylva.nosp@m.in@v.nosp@m.ertuo.nosp@m.z.fr

Version

0.5 BETA

Date

27/11/2014

Member Function Documentation

addDevice

(

)

Récupérer les différents modes de ventilation

Parameters

api	Doit être "addDevice"
token	Chaine de caractère
type	Chaine de caractère : "and" ou "ios"
key	Voir description générale de l'API (non-obligatoire ici - à renseigner si l'utilisateur est connecté)

Returns

Tableau comprenant l'objet du mode de ventilation et la correspondances des images

arborescence

(

)

Récupérer tous les éléments et sous-éléments du menu

Parameters

api	Doit être "arborescence"

Returns

Tableau des éléments du menu

autorizeNotifs

(

)

Permet d'éditer l'autorisation des notifications.

Parameters

key	Voir description générale de l'API
api	Doit être "autorizeNotifs"
value	Booléen (0 ou 1) pour indiquer si l'utilisateur autorise ou non les notifications
token	Chaine de caractère
os	Chaine de caractère

Returns

Objet utilisateur modifié

checkAutorisation

(

)

On teste si l'utilisateur est toujours autorisé à être connecté

Parameters

api	Doit être "checkAutorisation"
key	Voir description générale de l'API

Returns

Booléen

connexion

(

)

Permet à un utilisateur de se connecter en fonction de l'email ou du login et du mot de mot de passe.

Parameters

api	Doit être "connexion"
login	Doit être le pseudo ou l'adresse e-mail
mdp	Doit être le mot de passe encodé en md5
registration_id	Chaine de caractère qui correspond à l'id de l'appareil utilisé

Returns

Objet utilisateur si connexion réussie.

getContenu

(

)

Récupérer toutes les infos d'un contenu

Parameters

api	Doit être "getContenu"
id	Id du contenu souhaité

Returns

Tableau comprenant l'objet du contenu, la correspondances des images, l'image titre du contenu, url du document pdf, booléen si le contenu est un séparateur

getModeVentilation

(

)

Récupérer les différents modes de ventilation

Parameters

api	Doit être "getModeVentilation"
id	Id du mode souhaité

Returns

Tableau comprenant l'objet du mode de ventilation et la correspondances des images

getProduit

(

)

Récupérer toutes les infos d'un produit

Parameters

api	Doit être "getProduit"
id	Id du produit souhaité

Returns

Tableau comprenant l'objet du produit, la correspondances des images, les ids des modes de ventilation, le dévérouillage, les paramètres et l'url du document pdf

inscription

(

)

Permet de s'inscrire à l'application. La méthode vérifie si le pseudo et l'adresse email ne sont pas déjà utilisés. Le compte est automatiquement en attente de validation.

Parameters

api	Doit être "inscription"
login	Chaine de caractères
email	Chaine de caractères
nom	Chaine de caractères
prenom	Chaine de caractères
mdp	Mot de passe encodé en md5
registration_id	Chaine de caractère qui correspond à l'id de l'appareil

Returns

Objet utilisateur si inscription réussie

motDePasseOublie

(

)

Génère un nouveau mot de passe aléatoire et l'envoie par mail à l'utilisateur.

Parameters

api	Doit être "motDePasseOublie"
email	Adresse email de l'utilisateur concerné

Returns

true

synchro

(

)

Récupérer les ids des contenus et des produits qui ont été modifiées depuis la dernière mise à jour

Parameters

api	Doit être "synchro"
tms	Timestamp de la dernière synchronisation

Returns

Tableau composé des ids des contenus et des ids des produits qui doivent être mis à jour ou supprimés

---

The documentation for this class was generated from the following file:

• api.php