Vous disposez d'un identifiant d'application et de deux clés d'API : une clé de développement (pour vos tests) et une clé de production (destinée à l'utilisation finale).
Pour demander vos clés, contactez-nous à l'adresse communication (arobase) flyerz (point) fr en nous expliquant votre besoin.
Vos clés d'API sont privées, conservez-les en lieu sûr.
Flyerz récupère pour le compte de ses clients le contenu évènementiel disponible sur internet sur la zone géographique voulue par les clients : concerts, expos, afterworks, évènements sportifs, petits ou grands... bref tout !
Le contenu est filtré, trié dans le but d'avoir le contenu le plus qualitatif possible : tous les évènements ont une photo, un titre, une description, un lieu, une adresse, des coordonnées géographiques etc...
Les évènements sont régulièrement mis à jour ou supprimés quand ils le sont dans leur base de données originelle.
Le contenu est par conséquent dynamique, l'API est donc destinée à un usage à la volée. Si vous désirez sauvegarder dans votre base de données les évènements Flyerz, vous pouvez souscrire à l'offre Export en nous contactant.
L'API dispose de nombreux outils pour récupérer les évènements que vous trouverez ci-dessous.
La route principale de l'API est https://api.flyerz.fr/v2/
.
Toutes les routes renvoient une réponse au format JSON.
Vous pouvez utiliser l'API en passant dans l'en-tête de la requête (le header) la clé Authorization
ayant pour valeur Bearer XYZ
(remplacez XIZ
par la clé d'API). C'est la méthode recommandée.
Autre possibilité, vous pouvez utiliser l'API en passant en paramètre POST
ou GET
suivant la route, le champ secretKey
avec pour valeur la clé d'API.
Dans les deux cas, vous devez également passer en paramètre POST
ou GET
suivant la route, le champ appId
avec pour valeur l'identifiant de votre application.
L'API dispose d'une route events/suggestions
pour recommander des évènements de manière personnalisée à l'utilisateur. L'Intelligence Artificielle se base sur ses consultations antérieures. Ainsi il convient de passer à chacune des routes de l'API dans le champ sourceUserId
un ID que vous aurez généré de votre côté qui permet à Flyerz d'identifier les requêtes qui proviennent d'un même device.
Cet identifiant ne doit pas pas être une donnée personnelle pour respecter l'anonymat de vos utilisateurs et pour respecter le RGPD sans avoir à demander aux utilisateurs d'accepter le partage de leurs données personnelles. Il peut s'agir par exemple de l'ID du device.
Vous avez la possibilité via notre back office de mettre en avant des évènements dans l'API. Ces évènements apparaîtront par exemple dans les premiers résultats de la recherche par exemple.
Pour les identifier, l'évènement a un champ isHighlighted
avec la valeur true
. Si vous voyez ce champ et cette valeur sur un évènement, il est recommandé de changer l'affichage visuel de l'évènement pour qu'il ressorte plus par rapport aux autres évènements.
Voici un exemple ci-dessous, où l'évènement mis en avant à gauche ressort plus que l'évènement à droite :
{"success": true,"events": [{"id": 123456,"name": "Swing quartet en concert","pictureURL": "https://...","type": {"name: "Concert","color: "#FE3065"},"startDate": "2022-08-31 20:00:00","endDate": "2022-08-31 22:00:00","description": "Blablabla...","phone": null, (facultatif)"website": null, (facultatif)"fee": "P", (F : gratuit, P : payant) (facultatif)"price": "12 €", (facultatif)"ticketURL": null, (lien de billetterie) (facultatif)"place": {"name": "Arena de Genève","pictureURL": null, (facultatif)"description": null, (facultatif)"address": "Route de l'Aéroport 29, 1218 Le Grand-Saconnex","city": "Le Grand-Saconnex","phone": null, (facultatif)"website": null, (facultatif)"latitude": 46.233581,"longitude": 6.112322},"isHighlighted": false,"creationDate": "2020-02-18 12:37:59","lastUpdate": "2020-02-19 15:25:48","canceled": false (facultatif)}]}
event
.
Elle renvoie aussi dans le champ highlightedEvents
des évènements mis en avant par vos clients ou partenaires. Il est recommandé de les afficher sur la page afin de leur donner de la visibilité.
Le champ similarEvents
renvoie des évènements du même type (des concerts si l'évènement recherché est un concert) qui peuvent être suggérés à l'utilisateur.{"success": true,"event": {"id": 123456,"name": "Swing quartet en concert","pictureURL": "https://...","type": {"name: "Concert","color: "#FE3065"},"startDate": "2022-08-31 20:00:00","endDate": "2022-08-31 22:00:00","description": "Blablabla...","phone": null, (facultatif)"website": null, (facultatif)"fee": "P", (F : gratuit, P : payant) (facultatif)"price": "12 €", (facultatif)"ticketURL": null, (lien de billetterie) (facultatif)"place": {"name": "Arena de Genève","pictureURL": null, (facultatif)"description": null, (facultatif)"address": "Route de l'Aéroport 29, 1218 Le Grand-Saconnex","city": "Le Grand-Saconnex","phone": null, (facultatif)"website": null, (facultatif)"latitude": 46.233581,"longitude": 6.112322},"isHighlighted": false,"creationDate": "2020-02-18 12:37:59","lastUpdate": "2020-02-19 15:25:48","canceled": false (facultatif)},"highlightedEvents": [],"similarEvents": []}
{"success": true,"events": [{"id": 123456,"name": "Swing quartet en concert","pictureURL": "https://...","type": {"name: "Concert","color: "#FE3065"},"startDate": "2022-08-31 20:00:00","endDate": "2022-08-31 22:00:00","description": "Blablabla...","phone": null, (facultatif)"website": null, (facultatif)"fee": "P", (F : gratuit, P : payant) (facultatif)"price": "12 €", (facultatif)"ticketURL": null, (lien de billetterie) (facultatif)"place": {"name": "Arena de Genève","pictureURL": null, (facultatif)"description": null, (facultatif)"address": "Route de l'Aéroport 29, 1218 Le Grand-Saconnex","city": "Le Grand-Saconnex","phone": null, (facultatif)"website": null, (facultatif)"latitude": 46.233581,"longitude": 6.112322},"isHighlighted": false,"creationDate": "2020-02-18 12:37:59","lastUpdate": "2020-02-19 15:25:48","canceled": false (facultatif)}]}
{"success": true}
{"success": true}
{"success": true,"selections": [{"id": 56,"name": "Spectacle","description": null, (facultatif)"pictureURL": null (facultatif)}]}
{"success": true,"events": [{"id": 123456,"name": "Swing quartet en concert","pictureURL": "https://...","type": {"name: "Concert","color: "#FE3065"},"startDate": "2022-08-31 20:00:00","endDate": "2022-08-31 22:00:00","description": "Blablabla...","phone": null, (facultatif)"website": null, (facultatif)"fee": "P", (F : gratuit, P : payant) (facultatif)"price": "12 €", (facultatif)"ticketURL": null, (lien de billetterie) (facultatif)"place": {"name": "Arena de Genève","pictureURL": null, (facultatif)"description": null, (facultatif)"address": "Route de l'Aéroport 29, 1218 Le Grand-Saconnex","city": "Le Grand-Saconnex","phone": null, (facultatif)"website": null, (facultatif)"latitude": 46.233581,"longitude": 6.112322},"isHighlighted": false,"creationDate": "2020-02-18 12:37:59","lastUpdate": "2020-02-19 15:25:48","canceled": false, (facultatif)"deleted": false (facultatif)}]}
L'API renvoie une erreurs si la requête n'est pas valide (ressource demandée inexistante, clé d'API incorrecte...).
Voici le format des erreurs renvoyées par l'API :
{"success": false,"error": {"type": "unknownAppId","message": "The app ID does not exist."}}