API du dictionnaire social multilingue

Documentation API

Bienvenue sur l'API O'Ypunu, votre portail pour intégrer notre dictionnaire multilingue dans vos applications.

Documentation interactive

Explorez toutes les fonctionnalités de notre API avec la documentation interactive Swagger :

Ouvrir Swagger UI

Démarrage rapide

Pour commencer à utiliser l'API O'Ypunu, suivez ces étapes :

  1. Créez un compte utilisateur ou obtenez vos identifiants API
  2. Authentifiez-vous pour recevoir un token JWT
  3. Incluez ce token dans l'en-tête Authorization de vos requêtes
  4. Commencez à explorer le dictionnaire et ses fonctionnalités
Voir les exemples

Endpoints principaux

GET /words Liste des mots
GET /words/search Recherche de mots avec filtres
GET /words/{id} Détails d'un mot spécifique
GET /categories Liste des catégories
POST /words Ajouter un nouveau mot (authentifié)
POST /auth/login Authentification
POST /words/{id}/favorite Ajouter un mot aux favoris
DELETE /words/{id}/favorite Retirer un mot des favoris

Exemple d'authentification

Obtenez un token JWT :

POST /auth/login
Content-Type: application/json

{
  "email": "votre-email@exemple.com",
  "password": "votre-mot-de-passe"
}

Utilisez le token dans vos requêtes :

GET /words/favorites/user
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Ressources