Vigilo > API

API

Page généré automatiquement depuis la documentation projet vigilo-backend

Présentation API Vigilo

Sommaire

Workflows
- Ajout d’une observation
Méthodes
- Récupération d’informations
  - Configurations
  - Observations
- Ajout/modifications informations
  - Observations
Données

Workflows

Ajout d’une observation

Création observation : Création de l’entrée et récupération des informations d’identification
Ajout d’une image à l’observation : Ajout de l’image
Récupération panel : Génération du panel

Méthodes

Récupération d’informations

Configurations

Vérification ACL

Compatibilité

Version backend >= 0.0.1

Requête

GET /acl.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	key	X	Clé privé de l’utilisateur	>= 0.0.1

Retour

JSON : Retourne les informations suivantes :

Type	Nom	Description	Compatibilité
str	role	Rôle correspondant à la clé (admin)	>= 0.0.1

Récupération catégories

Compatibilité

LEGACY

Requête

GET /get_categories_list.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité

Retour

JSON : Retourne les informations des Catégories.

Récupération catégories (legacy)

Compatibilité

LEGACY

Requête

GET /get_categories.php?

Récupération informations scope

Compatibilité

Version backend >= 0.0.4

Requête

GET /get_scope.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	scope	X	Nom du scope	>= 0.0.4

Retour

JSON : Retourne les informations du Scope.

Récupération version backend (legacy)

Compatibilité

Version backend <= 0.0.3

Requête

GET /get_version.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité

Retour

JSON : Retourne la version du backend

Type	Nom	Description	Compatibilité
str	version	Version du backend	<= 0.0.3

Observations

Récupération panel

Compatibilité

Version backend >= 0.0.1

Requête

GET /generate_panel.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	token	X	Token de l’observation	>= 0.0.1
URL	int	s		Largeur de l’image	>= 0.0.1
URL	str	key		Clé d’admin pour visualisation non pixelisée	>= 0.0.1
URL	str	secretid		Clé secret de l’observation pour visualisation non pixelisée	>= 0.0.1

Retour

Retourne une image

Type	Nom	Description	Compatibilité
image/png	/	Image	<= 0.0.4
image/jpeg	/	Image	>= 0.0.5

Récupération liste observations

Compatibilité

Version backend >= 0.0.1

Requête

GET /get_issues.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	int	c		filtre selon catégorie	>= 0.0.1
URL	int	t		filtre selon date	Changé en timestamp à partir de >= 0.0.5
URL	str	scope	X	filtre selon scope	>= 0.0.1
URL	int	status		filtre selon statut de l’observation	>= 0.0.1
URL	int	token		filtre selon token de l’observation	>= 0.0.1
URL	str / int	lat / lon / radius		filtre selon les coordonnées lat et lon et les observations autour dans la limite de radius (en mètres)	>= 0.0.1
URL	str	tokenfilters / fdistance		Se combine avec “token” pour afficher les observations similaires avec les filtres distance, categorie et/ou address. fdistance (distance est mètre) est à renseigner si distance est utilisé	>= 0.0.9
URL	int	count		limite le nombre d’occurences	>= 0.0.1
URL	int	offset		démarrage le nombre d’occurence en décallé	>= 0.0.1
URL	str	format		format (json,csv,geojson)	>= 0.0.3
URL	int	approved		filtre selon approbation)	>= 0.0.10
URL	bool	cityfield		Affiche la ville dans un champs dédié plutôt que dans l’adresse	>= 0.0.13
URL	int	cityid		filtre selon id de la ville	>= 0.0.13
URL	str	key		Clé d’admin pour donner accès à toutes les observations	>= 0.0.13
URL	int	since		nombre d’unités pour le filtre relatif sur la date	>= 0.0.19
URL	str	since_unit		unité pour le filtre relatif sur la date, valeur parmi : day, week, month, year	>= 0.0.19

Retour

JSON : Retourne la liste des observations.

Récupération photo originale

Compatibilité

Version backend >= 0.0.1

Requête

GET /get_photo.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	key	X	Clé privé de l’utilisateur	>= 0.0.1
URL	str	token	X	Token de l’observation	>= 0.0.1
URL	str	type		Type d’image (resolution/obs)	>= 0.0.14

Retour

Retourne une image

Type	Nom	Description	Compatibilité
image/jpeg	/	Image	>= 0.0.1

Ajout/modifications informations

Observations

Ajout d’une image à l’observation

Compatibilité

Version backend >= 0.0.1

Requête

POST /add_image.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	token	X	Token de l’observation	>= 0.0.1
URL	str	secretid	X	Clé secrète de l’observation	>= 0.0.1
URL	str	type		Type d’image (resolution/obs)	>= 0.0.14
RAW	image/jpeg	/	X	Flux de l’image en JPEG si method=stdin	>= 0.0.1
URL	str	method		Methode d’upload d’image (par defaut stdin pour upload en RAW / base64 pour upload en base64 dans le champs imagebin64)	>= 0.0.16
POST	JPEG base64	imagebin64		Image encodée en base64	= 0.0.16

Retour

JSON : Retourne les informations d’identification de l’observation

Type	Nom	Description	Compatibilité
bool	status	Retourne le statut de l’appel	>= 0.0.1 / < 0.0.10

Approuver observation

Compatibilité

Version backend >= 0.0.1

Requête

POST /approve.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	key		Clé privé de l’utilisateur	>= 0.0.1
POST	str	token	Uniquement en cas de modif	Token de l’observation	>= 0.0.1
POST	int	approved		0 => A approuver / 1 => Approuvé / 2 => Désapprouvé	>= 0.0.1

Retour

JSON : Retourne les informations d’identification de l’observation

Type	Nom	Description	Compatibilité

Création observation

Compatibilité

Version backend >= 0.0.1

Requête

POST /create_issue.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	key		Clé privé de l’utilisateur	>= 0.0.1
POST	str	token	Uniquement en cas de modif	Token de l’observation	>= 0.0.1
POST	str	coordinates_lat'	création	Latitude de l’observation	>= 0.0.1
POST	str	coordinates_lon	création	Longitude de l’observation	>= 0.0.1
POST	str	comment	non	Remarque de l’observation (max 50 caractères)	>= 0.0.1
POST	str	explanation	non	Explications observation	>= 0.0.1
POST	str	categorie	création	ID de catégorie	>= 0.0.1
POST	str	address	création	Adresse de l’observation	>= 0.0.1
POST	str	time	création	Timestamp de l’observation au format Unix en ms	>= 0.0.1
POST	str	version	création	Version de l’application cliente	>= 0.0.1
POST	str	scope	création	Identifiant du scope	>= 0.0.1
POST	str	cityid	création	Identifiant de la ville	>= 0.0.13
POST	str	cityname	création	Nom de la ville	>= 0.0.13

Retour

JSON : Retourne les informations d’identification de l’observation

Type	Nom	Description	Compatibilité
str	token	Retourne le token généré	>= 0.0.1
str	secretid	Retourne la clé secrete de l’observation	>= 0.0.1
int	group	LEGACY	LEGACY

Créer résolution

Compatibilité

Version backend >= 0.0.14

Requête

POST /create_resolution.php

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	token		Token de la résolution	>= 0.0.14
POST	str	comment		Commentaire de résolution (max 50 chars)	>= 0.0.14
POST	int	time	X	Timestamp format Unix	>= 0.0.14
POST	str	tokenlist	X	Liste, séparée par une virgule des tokens d’observations	>= 0.0.14
POST	str	version		Version du client	>= 0.0.14

Retour

JSON : Retourne les informations d’identification de la résolution

Type	Nom	Description	Compatibilité
str	token	Retourne le token généré	>= 0.0.1
str	secretid	Retourne la clé secrete de l’observation	>= 0.0.14

Suppression observation

Compatibilité

Version backend >= 0.0.1

Requête

GET /delete.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	key	Si secretid non fourni		Clé privé de l’utilisateur
URL	str	token	Uniquement en cas de modif	Token de l’observation	>= 0.0.1
URL	str	secretid	Si key non fourni		Clé secrète de l’observation >= 0.0.1

Retour

JSON : Retourne les informations d’identification de l’observation

Type	Nom	Description	Compatibilité

Obtenir liste observations en CSV (legacy)

Compatibilité

Version backend <= 0.0.5

Requête

GET /to_csv.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité

Retour

CSV : Retourne les informations d’identification de l’observation

Changer status observation

Compatibilité

LEGACY

Requête

GET /update_status.php?

Arguments

Localisation	Type	Nom	Obligatoire ?	Description	Compatibilité
URL	str	key	Si secretid non fourni	Clé privé de l’utilisateur	>= 0.0.5
URL	str	token	X	Token de l’observation	>= 0.0.5
URL	str	secretid	Si key non fourni	Clé secrète de l’observation	>= 0.0.5
URL	int	statusobs	X	Status à appliquer (0: non résolu / 1 : résolu)	>= 0.0.5
POST	str	comment		Commentaire de résolution (max 50 chars)	>= 0.0.10
POST	int	time		Timestamp format Unix	>= 0.0.10

Retour

JSON : Retourne les informations d’identification de l’observation

Type	Nom	Description	Compatibilité

Obtenir carte en cache

Compatibilité

Version backend >= 0.0.1

Requête

GET /maps/{TOKEN}_zoom.jpg

Données

Catégories

Les catégories sont disponibles sur toutes les instance sur l’adresse https://vigilo-bf7f2.firebaseio.com/categorieslist.json

Type	Nom	Description	Compatibilité
int	catid	Identifiant unique de catégorie	>= 0.0.1
str	catname	Nom affiché de la catégorie	>= 0.0.1

Observations

Type	Nom	Description	Compatibilité
str	token	Token de l’observation	>= 0.0.1
str	coordinate_lat	Latitude de l’observation en dégré décimal	>= 0.0.1
str	coordinate_lon	Longitude de l’observation en dégré décimal	>= 0.0.1
str	address	Adresse de l’observation	>= 0.0.1
str	comment	Remarque de l’observation	>= 0.0.1
str	explanation	Explications de l’observation	>= 0.0.1
int	time	Timestamp (en secondes) de l’observation	>= 0.0.1
int	status	Statut de l’observation (voir “Status des observations”)	>= 0.0.6
int	group	Groupe de l’observation	LEGACY
int	categorie	Identifiant de catégorie de l’obseration	>= 0.0.1
int	approved	Etat d’approbation de l’observation	>= 0.0.1
int	cityname	Nom de la ville (si existe, n’est pas affiché dans l’adresse)	>= 0.0.13

Scope

Type	Nom	Description	Compatibilité
str	display_name	Nom affiché du scope dans Vigilo	>= 0.0.5
str	coordinate_lat_min	Latitude minimum de la zone en dégré décimal	>= 0.0.5
str	coordinate_lat_max	Latitude maximum de la zone en dégré décimal	>= 0.0.5
str	coordinate_lon_min	Longitude minimum de la zone en dégré décimal	>= 0.0.5
str	coordinate_lon_max	Longitude maximum de la zone en dégré décimal	>= 0.0.5
str	map_center_string	Latitude + “,” + Longitude du centre de la carte qui doit être affichée	>= 0.0.5
int	map_zoom	Zoom de la carte à afficher	>= 0.0.5
str	contact_email	Adresse mail de contact du scope	>= 0.0.5
str	tweet_content	ontenu du tweet qui mis par défaut via le composant de partage de l’application	>= 0.0.5
str	map_url	Adresse de la carte où sont affichées les observations	>= 0.0.5
str	nominatim_urlbase	URL base du service nominatim	>= 0.0.14
str	backend_version	Version du backend	>= 0.0.5

Status des observations

Type	Nom	Description	Compatibilité
int	status	0 => Nouvelle observation 1 => Observation résolue 2 => Prise en compte 3 => En cours de résolution 4 => Indiquée comme résolue	>= 0.0.10