API REST v1.0

Une API, pour qui et pour quoi faire ?

Dans une démarche d'ouverture sur l'extérieur, Le Pacha met à disposition des développeurs informatiques une API complète donnant accès à la plupart des fonctionnalités du site.

Envie de développer une application mobile ? De proposer une interface alternative au site du Pacha pour répondre à un besoin spécifique ? Cette API est faite pour vous !

Avertissement

L'utilisation de cette API est soumise aux conditions d'utilisation mentionnées sur la page des conditions générales d'utilisation du site.

API endpoint

Révision : v1.0
Potocole de transport : HTTP
Url de base : https://www.lepacha.net/api/v1

Note : malgré le terme "REST" utilisé pour qualifier cette API, elle n'est pas complètement "stateless" étant donné qu'elle se base sur un cookie de session (donc avec une TTL à 0 et nommé PACHA_API_SESSID) pour traiter la question du maintien de la session utilisateur entre deux requêtes.

Requête sur l'API

Les requêtes se font sous la forme d'un POST HTTP, exactement comme vous le feriez avec un formulaire HTML.

Exemple pour une requête simple : POST /v1/xyz HTTP/1.1 Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Accept-Encoding: gzip, deflate Accept-Language: fr,fr-fr;q=0.8,en-us;q=0.5,en;q=0.3 Connection: keep-alive Host: www.lepacha.net User-Agent: CURL Content-Length: xxx Content-Type: application/x-www-form-urlencoded param1=valeur1&param2=valeur2

Exemple pour une requête avec upload de fichier : POST /v1/xyz HTTP/1.1 Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Accept-Encoding: gzip, deflate Accept-Language: fr,fr-fr;q=0.8,en-us;q=0.5,en;q=0.3 Connection: keep-alive Host: www.lepacha.net User-Agent: CURL Content-Length: xxx Content-Type: multipart/form-data; boundary=---------------------------3529971861389506046367911500 -----------------------------3529971861389506046367911500 Content-Disposition: form-data; name="param1" value1 -----------------------------3529971861389506046367911500 Content-Disposition: form-data; name="param2" value2 -----------------------------3529971861389506046367911500 Content-Disposition: form-data; name="file"; filename="my_image.jpg" Content-Type: application/image-jpeg [...] -----------------------------3529971861389506046367911500--

Note : quelques rares requêtes ne fonctionnent qu'en GET HTTP. Dans ce cas, les paramètres sont passés dans l'URL.
Exemple : https://www.lepacha.net/api/v1/xyz?param1=valeur1&param2=valeur2

Réponse type

En cas de succès

Code de réponse HTTP : 200
Format de la réponse : JSON

Exemple : { "data": [...], Données de la réponse "warnings": [ Avertissements occasionés par l'appel. Il s'agit d'informations non-critiques qui n'ont pas interrompu les traitements. [...] ] } Le champ "warnings" est présent en prévision de futures évolutions de l'API. Il est, pour le moment, toujours vide.

En cas d'erreur

Code de réponse HTTP : 4xx, 500
Format de la réponse : JSON

Exemple : { "status": "[...]", Message d'erreur "details": { [...] Informations complémentaires sur l'erreur } }

Les fonctions de l'API utilisent le champ "details" pour indiquer avec précision la raison d'un refus de requête. Dans ce cas une erreur HTTP 400 est renvoyée et le champ "details" contient, pour chaque champ, les erreurs asssociées.

Exemple : { "status": "input_data_validation_error", "details": { "login": ["login_required"] Le login n'a pas été fourni "password": ["password_required"] Le mot de passe n'a pas été fourni } }

Fonctions de l'API

Ping

Teste la connexion avec l'API.

URL : https://www.lepacha.net/api/v1/ping
Méthode : GET, POST

Réponse

Type	`string`
Description	Retourne l'état d'authentification : `"logged_in"`, `"not_logged_in"`

Login

Authentifie l'utilisateur et ouvre une session sur l'API.

URL : https://www.lepacha.net/api/v1/login
Méthode : POST

Paramètres

Nom	Type	Description	Requis
login	`string`	Login de l'utilisateur	oui
password	`string`	Mot de passe	oui

Réponse

Type	`string`
Description	Retourne `"done"` en cas d'authentification réussie, sinon renvoit une erreur 403

Erreurs

Erreur HTTP 400
login_required	Login requis
password_required	Mot de passe requis
Erreur HTTP 403
bad_login_or_password	Login ou mot de passe incorrect

Logout

Termine la session utilisateur courante sur l'API.

URL : https://www.lepacha.net/api/v1/logout
Méthode : POST

Réponse

Type	`string`
Description	Retourne `"done"`

Charger profil utilisateur

Retourne des informations sur le profil de l'utilisateur authentifié, dans le contexte d'un groupe donné.

URL : https://www.lepacha.net/api/v1/profile/get
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui

Réponse

Type object

Description Informations du profil : { "login": [...], Login "email": [...], e-mail "creation_date": [...], Date de création du compte utilisateur (format "AAAA-MM-JJ HH:MM:SS") "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "address": [...], Adresse "zip_code": [...], Code postal "city": [...], Ville "country": [...], Pays "more_address": [...], Coordonnées complémentaires "phone": [...], Téléphone fixe "mobile_phone": [...], Téléphone mobile "web_site": [...], Site web "birth_date": [...], Date de naissance (format "AAAA-MM-JJ HH:MM:SS") "summary": [...], Texte de présentation du profil "skype_id": [...], Identifiant Skype "icq_id": [...], Identifiant ICQ "twitter_id": [...], Identifiant Twitter "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max }, "credentials": [ [...] ], Liste des droits sur le groupe (1 : administrer le groupe / 3 : poster des contenus) "notifications": [ [...] ] Liste des notification sur le groupe (1 : alerte anniversaire / 2 : alerte nouveau contenu) }

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
Erreur HTTP 403
forbidden	accès interdit

Modifier profil utilisateur

Met à jour les informations d'identité du profil utilisateur.

URL : https://www.lepacha.net/api/v1/profile/updateUser
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
gender	`string`	Civilité ("M.", "Mme.")	oui
firstname	`string`	Pénom	oui
lastname	`string`	Nom	oui
email	`string`	e-mail (requis si utilisateur est administrateur d'un groupe)	non
address	`string`	Adresse	non
zip_code	`string`	Code postal	non
city	`string`	Ville	non
country	`string`	Pays	non
more_address	`string`	Coordonnées complémentaires	non
phone	`string`	Téléphone fixe	non
mobile_pone	`string`	Téléphone portable	non
web_site	`string`	Site web ("http://" sera automatiquement ajouté si non présent)	non
birth_date	`string`	Date de naissance au format "JJ/MM/AAAA"	non
summary	`string`	Texte de présentation du profil	non
skype_id	`string`	Identifiant Skype	non
icq_id	`string`	Identifiant ICQ	non
twitter_id	`string`	Identifiant Twitter	non
password	`string`	Nouveau mot de passe (6 caractères minimum, mettre simplement à `null` si vous ne voulez pas le modifier)	non

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
gender_required	Civilité requise
firstname_required	Prénom requis
lastname_required	Nom requis
invalid_email_address	Adresse e-mail invalide
invalid_web_site_address	URL invalide
invalid_birth_date	Date invalide
invalid_icq_id	Identifiant ICQ invalide
invalid_twitter_id	Identifiant Twitter invalide
too_short_password	Mot de passe trop court
Erreur HTTP 403
forbidden	accès interdit

Modifier l'avatar du profil utilisateur

Modifie le fichier image de l'avatar du profil utilisateur.

URL : https://www.lepacha.net/api/v1/profile/updateAvatar
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
avatar	`file`	fichier image (image au format JPEG < 10 Mo)	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
avatar_file_required	Fichier d'avatar requis
avatar_file_must_be_jpeg_image	Fichier d'avatar doit être une image JPEG
avatar_file_too_large	Fichier d'avatar trop lourd
Erreur HTTP 403
forbidden	accès interdit

Modifier les notifications du profil utilisateur

Modifie les types de notifications voulues sur le profil utilisateur.

URL : https://www.lepacha.net/api/v1/profile/updateAvatar
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
notifications[ ]	`array`	Liste des notifications voulues sur le groupe (1 : alerte anniversaire / 2 : alerte nouveau contenu)	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
invalid_notifications	Type de norification non valide
Erreur HTTP 403
forbidden	accès interdit

Lister les groupes

Liste les groups dont fait partie l'utilisateur.

URL : https://www.lepacha.net/api/v1/groups/get
Méthode : GET, POST

Réponse

Type	`object`
Description	Liste des groupes :`{ "[...]": { ID de groupe "title": [...], Titre "description": [...], Description "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") } }`

Erreurs

Erreur HTTP 403
forbidden	accès interdit

Lister les utilisateurs

Retourne la liste des utilisateurs d'un groupe.

URL : https://www.lepacha.net/api/v1/directory/get
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui

Réponse

Type object

Description Informations du profil : { "[...]": { ID de l'utilisateur "login": [...], Login "email": [...], e-mail "creation_date": [...], Date de création du compte utilisateur (format "AAAA-MM-JJ HH:MM:SS") "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "address": [...], Adresse "zip_code": [...], Code postal "city": [...], Ville "country": [...], Pays "more_address": [...], Coordonnées complémentaires "phone": [...], Téléphone fixe "mobile_phone": [...], Téléphone mobile "web_site": [...], Site web "birth_date": [...], Date de naissance (format "AAAA-MM-JJ HH:MM:SS") "summary": [...], Texte de présentation du profil "skype_id": [...], Identifiant Skype "icq_id": [...], Identifiant ICQ "twitter_id": [...], Identifiant Twitter "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } }, [...] }

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
Erreur HTTP 403
forbidden	accès interdit

Charger l'avatar d'un utilisateur

Retourne les données de l'image d'un avatar.

URL : https://www.lepacha.net/api/v1/directory/avatar
Méthode : GET

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
user_id	`int`	ID de l'utilisateur	oui
index_config	`string`	Index de configuration déterminant la taille de l'image (`"xs"`, `"s"`, `"m"`, `"l"`, `"xl"`)	oui

Réponse

Type	`raw`
Description	Données binaires

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
user_id_required	ID utilisateur requis
index_config_id_required	Index de configuration requis
Erreur HTTP 403
forbidden	accès interdit

Créer un message

Crée un nouveau message.

URL : https://www.lepacha.net/api/v1/messages/createMessage
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
content	`string`	Contenu du message	oui

Réponse

Type	`int`
Description	Retourne l'ID du message

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
content_required	Contenu requis
Erreur HTTP 403
forbidden	accès interdit

Créer un album

Crée un nouvel album.

URL : https://www.lepacha.net/api/v1/messages/createAlbum
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
title	`string`	Titre	oui
content	`string`	Contenu de description	oui
category	`string`	Catégorie	oui

Réponse

Type	`int`
Description	Retourne l'ID de l'album

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
title_required	Title requis
category_required	Catégorie requise
Erreur HTTP 403
forbidden	accès interdit

Créer un événement

Crée un nouvel événement.

URL : https://www.lepacha.net/api/v1/messages/createEvent
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
title	`string`	Titre	oui
content	`string`	Contenu de description	oui
date	`string`	Date de début (format "AAAA-MM-JJ HH:MM:SS")	oui
duration	`int`	Durée en jour	oui

Réponse

Type	`int`
Description	Retourne l'ID de l'album

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
title_required	Title requis
content_required	Contenu requis
date_required	Date requise
invalid_date	Date non valide
duration_required	Durée requise
invalid_duration	Durée non valide
Erreur HTTP 403
forbidden	accès interdit

Mettre à jour un message

Met à jour un message.

URL : https://www.lepacha.net/api/v1/messages/updateMessage
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui
content	`string`	Contenu du message	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
content_required	Contenu requis
Erreur HTTP 403
forbidden	accès interdit

Mettre à jour un album

Met à jour un album.

URL : https://www.lepacha.net/api/v1/messages/updateAlbum
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui
title	`string`	Titre	oui
content	`string`	Contenu de description	oui
category	`string`	Catégorie	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
title_required	Title requis
category_required	Catégorie requise
Erreur HTTP 403
forbidden	accès interdit

Mettre à jour un événement

Met à jour un événement.

URL : https://www.lepacha.net/api/v1/messages/updateEvent
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui
title	`string`	Titre	oui
content	`string`	Contenu de description	oui
date	`string`	Date de début (format "AAAA-MM-JJ HH:MM:SS")	oui
duration	`int`	Durée en jour	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
title_required	Title requis
content_required	Contenu requis
date_required	Date requise
invalid_date	Date non valide
duration_required	Durée requise
invalid_duration	Durée non valide
Erreur HTTP 403
forbidden	accès interdit

Supprimer un message

Supprimer un message (messages, albums et évenements confondus).

URL : https://www.lepacha.net/api/v1/messages/delete
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
Erreur HTTP 403
forbidden	accès interdit

Lister les messages

Liste les messages.

URL : https://www.lepacha.net/api/v1/messages/get
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
type	`int`	Filtre sur le type de message (0 : messages / 1 : albums / 2 : événements)	non
query	`string`	Filtre sur le contenu des messages par mot cléf	non
category	`string`	Filtre sur la catégorie des albums (ignoré si le filtre de type est inactif ou positionné sur autre chose que les albums)	non
offset	`int`	Position dans la liste à partir de laquelle les résultats doivent être retournés	oui
count	`int`	Nombre de résultats maxi à retourner	oui
message_id	`int`	Filtre pour ne retourner qu'un message en particulier (les autres filtres sont ignorés dans ce cas)	non
get_documents	`int`	Flag indiquant que l'on souhaite récupérer les documents du message (0 : non / 1 : oui)	oui
get_count	`int`	Flag indiquant que l'on souhaite récupérer le nombre total de résultats	oui

Réponse

Type obkject

Description Liste de messages : { "count": "[...]", Nombre total de résultats (si le flag "get_count" est activé) "messages": { Liste des messages "[...]": { ID du message "is_pinned": [...], Flag indiquant si épinglé (0 : non / 1 : oui) "is_new": [...], Flag indiquant si nouveau (0 : non / 1 : oui) "type": [...], Type de message (0 : messages / 1 : albums / 2 : événements) "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") "author": { Auteur du message "id": [...], ID du compte utilisateur "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } }, "title": [...], Titre (albums et événements uniquement) "content": [...], Contenu, description "category": [...], Catégorie (albums uniquement) "date": [...], Date de début (événements uniquement) "duration": [...], Durée en jour (événements uniquement) "documents": {[...] Documents joints (si le flag "get_documents" est activé) "[...]": { ID du document "is_new": [...], Flag indiquant si épinglé (0 : non / 1 : oui) "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") "legend": [...], Légende "type": [...], Type de document (0 : autre / 1 : photo / 2 : vidéo / 3 : audio) "file_name": [...], Nom du fichier d'origine "author": { Auteur du document "id": [...], ID du compte utilisateur "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } }, "display_url": { URL d'affichage "preview_xs": [...], Aperçu en taille 16x16 max "preview_s": [...], Aperçu en taille 32x32 max "preview_m": [...], Aperçu en taille 64x64 max "preview_l": [...], Aperçu en taille 128x128 max "preview_xl": [...], Aperçu en taille 256x256 max "l_xs": [...], Basse qualité en taille 500x500 max "l_s": [...], Basse qualité en taille 600x600 max "l_m": [...], Basse qualité en taille 800x800 max "l_l": [...], Basse qualité en taille 1000x1000 max "l_xl": [...], Basse qualité en taille 1500x1500 max "l_xxl": [...], Basse qualité en taille 2000x2000 max "m_xs": [...], Qualité moyenne en taille 500x500 max "m_s": [...], Qualité moyenne en taille 600x600 max "m_m": [...], Qualité moyenne en taille 800x800 max "m_l": [...], Qualité moyenne en taille 1000x1000 max "m_xl": [...], Qualité moyenne en taille 1500x1500 max "m_xxl": [...], Qualité moyenne en taille 2000x2000 max "h_xs": [...], Haute qualité en taille 500x500 max "h_s": [...], Haute qualité en taille 600x600 max "h_m": [...], Haute qualité en taille 800x800 max "h_l": [...], Haute qualité en taille 1000x1000 max "h_xl": [...], Haute qualité en taille 1500x1500 max "h_xxl": [...] Haute qualité en taille 2000x2000 max }, "download_url": [...], URL de téléchargement }, [...] }, "comments": {[...] Commentaires (si le flag "get_comments" est activé) "[...]": { ID du commentaire "is_new": [...], Flag indiquant si épinglé (0 : non / 1 : oui) "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") "content": [...], Contenu "author": { Auteur du commentaire "id": [...], ID du compte utilisateur "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } } }, [...] } }, [...] } }

Type	`obkject`
Description	Liste de messages : { "count": "[...]", Nombre total de résultats (si le flag "get_count" est activé) "messages": { Liste des messages "[...]": { ID du message "is_pinned": [...], Flag indiquant si épinglé (0 : non / 1 : oui) "is_new": [...], Flag indiquant si nouveau (0 : non / 1 : oui) "type": [...], Type de message (0 : messages / 1 : albums / 2 : événements) "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") "author": { Auteur du message "id": [...], ID du compte utilisateur "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } }, "title": [...], Titre (albums et événements uniquement) "content": [...], Contenu, description "category": [...], Catégorie (albums uniquement) "date": [...], Date de début (événements uniquement) "duration": [...], Durée en jour (événements uniquement) "documents": {[...] Documents joints (si le flag "get_documents" est activé) "[...]": { ID du document "is_new": [...], Flag indiquant si épinglé (0 : non / 1 : oui) "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") "legend": [...], Légende "type": [...], Type de document (0 : autre / 1 : photo / 2 : vidéo / 3 : audio) "file_name": [...], Nom du fichier d'origine "author": { Auteur du document "id": [...], ID du compte utilisateur "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } }, "display_url": { URL d'affichage "preview_xs": [...], Aperçu en taille 16x16 max "preview_s": [...], Aperçu en taille 32x32 max "preview_m": [...], Aperçu en taille 64x64 max "preview_l": [...], Aperçu en taille 128x128 max "preview_xl": [...], Aperçu en taille 256x256 max "l_xs": [...], Basse qualité en taille 500x500 max "l_s": [...], Basse qualité en taille 600x600 max "l_m": [...], Basse qualité en taille 800x800 max "l_l": [...], Basse qualité en taille 1000x1000 max "l_xl": [...], Basse qualité en taille 1500x1500 max "l_xxl": [...], Basse qualité en taille 2000x2000 max "m_xs": [...], Qualité moyenne en taille 500x500 max "m_s": [...], Qualité moyenne en taille 600x600 max "m_m": [...], Qualité moyenne en taille 800x800 max "m_l": [...], Qualité moyenne en taille 1000x1000 max "m_xl": [...], Qualité moyenne en taille 1500x1500 max "m_xxl": [...], Qualité moyenne en taille 2000x2000 max "h_xs": [...], Haute qualité en taille 500x500 max "h_s": [...], Haute qualité en taille 600x600 max "h_m": [...], Haute qualité en taille 800x800 max "h_l": [...], Haute qualité en taille 1000x1000 max "h_xl": [...], Haute qualité en taille 1500x1500 max "h_xxl": [...] Haute qualité en taille 2000x2000 max }, "download_url": [...], URL de téléchargement }, [...] }, "comments": {[...] Commentaires (si le flag "get_comments" est activé) "[...]": { ID du commentaire "is_new": [...], Flag indiquant si épinglé (0 : non / 1 : oui) "creation_date": [...], Date de création (format "AAAA-MM-JJ HH:MM:SS") "content": [...], Contenu "author": { Auteur du commentaire "id": [...], ID du compte utilisateur "gender": [...], Civilité "lastname": [...], Nom "firstname": [...], Prénom "avatar": { URL vers l'avatar "xs": [...], Image en taille 16x16 max "s": [...], Image en taille 32x32 max "m": [...], Image en taille 64x64 max "l": [...], Image en taille 128x128 max "xl": [...] Image en taille 256x256 max } } }, [...] } }, [...] } }

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
invalid_message_type	Type d emessage non valide
offset_required	Offset requis
invalid_offset	Offset non valide
count_required	Nombre requis
invalid_count	Nombre non valide
invalid_message_id	ID de message non valide
get_documents_flag_required	Flag requis
invalid_get_documents_flag_value	Valeur de flag non valide
get_count_flag_required	Flag requis
invalid_get_count_flag_value	Valeur de flag non valide
Erreur HTTP 403
forbidden	accès interdit

Epingler un message

Epingle un message (messages, albums et évenements confondus).

URL : https://www.lepacha.net/api/v1/messages/pin
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
Erreur HTTP 403
forbidden	accès interdit

Désépingler un message

Désépingle un message (messages, albums et évenements confondus).

URL : https://www.lepacha.net/api/v1/messages/unpin
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
Erreur HTTP 403
forbidden	accès interdit

Lister les catégories d'album

Liste les catégorie d'album photos.

URL : https://www.lepacha.net/api/v1/messages/getCategories
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui

Réponse

Type	`array`
Description	Retourne une liste de catégories : `[ "Catégorie 1", "Catégorie 2", [...] ]`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
Erreur HTTP 403
forbidden	accès interdit

Créer un commentaire

Crée un nouveau commentaire sur un message.

URL : https://www.lepacha.net/api/v1/comments/create
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui
content	`string`	Contenu du commentaire	oui

Réponse

Type	`int`
Description	Retourne l'ID du commentaire

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
content_required	Contenu requis
Erreur HTTP 403
forbidden	accès interdit

Mettre à jour un commentaire

Met à jour un commentaire.

URL : https://www.lepacha.net/api/v1/comments/update
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
comment_id	`int`	ID du commentaire	oui
content	`string`	Contenu du commentaire	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
comment_id_required	ID de commentaire requis
content_required	Contenu requis
Erreur HTTP 403
forbidden	accès interdit

Supprimer un commentaire

Supprimer un commentaire.

URL : https://www.lepacha.net/api/v1/comments/delete
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
comment_id	`int`	ID du commentaire	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
comment_id_required	ID de commentaire requis
Erreur HTTP 403
forbidden	accès interdit

Créer un document

Crée un nouveau document sur un message.

URL : https://www.lepacha.net/api/v1/documents/create
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
message_id	`int`	ID du message	oui
legend	`string`	Légende du document	non
file	`file`	Fichier contenant les données du document	oui

Réponse

Type	`int`
Description	Retourne l'ID du document

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
message_id_required	ID du message requis
file_required	Fichier requis
Erreur HTTP 403
forbidden	accès interdit

Mettre à jour un document

Met à jour un document.

URL : https://www.lepacha.net/api/v1/documents/update
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
document_id	`int`	ID du document	oui
legend	`string`	Légende du document	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
document_id_required	ID du document requis
legend_required	Légende requise
Erreur HTTP 403
forbidden	accès interdit

Supprimer un document

Supprimer un document.

URL : https://www.lepacha.net/api/v1/documents/delete
Méthode : POST

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
document_id	`int`	ID du document	oui

Réponse

Type	`string`
Description	Retourne `"done"`

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
document_id_required	ID du document requis
Erreur HTTP 403
forbidden	accès interdit

Charger l'aperçu d'un document

Retourne les données de l'image d'aperçu d'un docment.

URL : https://www.lepacha.net/api/v1/documents/display
Méthode : GET

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
document_id	`int`	ID du document	oui
index_config	`string`	Index de configuration déterminant la taille de l'image (`"preview_xs"`, `"preview_s"`, `"preview_m"`, `"preview_l"`, `"preview_xl"`, `"l_xs"`, `"l_s"`, `"m_xs"`, `"m_s"`, `"m_m"`, `"m_l"`, `"m_xl"`, `"m_xxl"`, `"h_xs"`, `"h_s"`, `"h_m"`, `"h_l"`, `"h_xl"`, `"h_xxl"`)	oui

Réponse

Type	`raw`
Description	Données binaires

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
document_id_required	ID du document requis
index_config_id_required	Index de configuration requis
Erreur HTTP 403
forbidden	accès interdit

Télécharger un document

Retourne les données brutes d'un document.

URL : https://www.lepacha.net/api/v1/documents/download
Méthode : GET

Paramètres

Nom	Type	Description	Requis
group_id	`int`	ID du groupe	oui
document_id	`int`	ID du document	oui

Réponse

Type	`raw`
Description	Données binaires

Erreurs

Erreur HTTP 400
group_id_required	ID de groupe requis
invalid_group_id	ID de groupe non valide
document_id_required	ID du document requis
Erreur HTTP 403
forbidden	accès interdit