API NOÉ
Bienvenue dans la documentation officielle de l'API NOÉ ! Cette API REST vous permet d'intégrer et de gérer les festivals et événements de manière programmatique.
🚀 Commencer
Si tu utilises Insomnia ou Postman, voici un fichier que tu peux importer avec de nombreux exemples de requêtes : Télécharger le fichier Insomnia
Base URL
https://api.noe-app.io/
Format des données
Toutes les requêtes et réponses utilisent le format JSON.
🏗️ Architecture
L'API NOÉ suit les principes RESTful et utilise les standards modernes :
Principes RESTful
- GET - Récupérer des ressources
- POST - Créer des ressources
- PUT - Mettre à jour complètement
- PATCH - Mettre à jour partiellement
- DELETE - Supprimer des ressources
Standards utilisés
- Authentification: JWT (JSON Web Tokens)
- Filtrage: MongoDB-like queries sur les endpoints de listage
- Compression des requêtes: Gzip
👀 Que veux-tu faire ensuite ?
📄️ Authentification
L'API NOÉ utilise une authentification basée sur JWT (JSON Web Tokens) pour sécuriser l'accès aux endpoints.
📄️ Filtrage
Le système de filtrage de l'API NOÉ permet d'appliquer des filtres complexes sur les endpoints LIST en utilisant une syntaxe inspirée de MongoDB.
📄️ Champs imbriqués
Guide complet sur la manipulation des champs imbriqués dans l'API NOÉ, incluant les champs personnalisés et les objets complexes.
📄️ Billetterie
La billetterie est probablement ce que vous aurez envie d'automatiser au plus vite. Voici quelques idées :
📄️ Webhooks
NOÉ permet l'utilisation de webhooks. Voici comment ils marchent !