Nouvelle API Affirmations

Nouvelle API Affirmations

Des boucles infinies au bien-être instantané : l’API Affirmations a été entièrement repensée pour offrir une positivité quotidienne personnalisée, sans la moindre friction. Chaque affirmation est désormais livrée avec un ID stable, des données propres et épurées, et un schéma riche — ainsi que la recherche, la pagination, les points de terminaison par lot et quotidiens, une boîte à outils de bien-être complète, et des réponses en texte brut pour les SMS et les assistants vocaux.

🚀 Nouveautés

  • ID stables – Chaque affirmation porte un id cohérent basé sur un hachage, afin que les widgets, les notifications et les caches restent synchronisés.
  • Données propres, automatiquement – Les champs de texte et de catégorie sont débarrassés des espaces superflus avant d’atteindre votre application.
  • Catégories intelligentes – Les 19 catégories sont dérivées directement du jeu de données et triées, sans dérive codée en dur.
  • Erreurs utiles – Les catégories inconnues renvoient un 404 clair au lieu de rester bloquées ou de boucler.
  • Schéma plus riche – Chaque affirmation renvoie id, text, category, mood, lang et length.
  • Trouvez ce qu’il vous faut – Recherche et pagination sur le point de terminaison de liste, plus un point de terminaison par lot configurable.
  • Sélections quotidiennes déterministes – /today renvoie la même affirmation du jour pour chaque utilisateur.
  • Boîte à outils de bien-être – Personnalisez par prénom, reformulez les pensées négatives et associez les affirmations à des exercices de respiration.

🛠 Points de terminaison de l’API

1. Lister les affirmations

GET /v1/affirmations

Paramètres :

  • category (facultatif) : Filtrer la liste par catégorie, comme confidence ou self-love.
  • search (facultatif) : Recherche plein texte dans le texte des affirmations.
  • page (par défaut : 1) : Numéro de page pour la pagination.
  • limit (par défaut : 10) : Résultats par page, jusqu’à un maximum de 50.
  • lang (par défaut : en) : Code de langue. Le contenu anglais est renvoyé dans cette version.

2. Affirmation aléatoire

GET /v1/affirmations/random

Paramètres :

  • category (facultatif) : Renvoyer une affirmation aléatoire d’une catégorie spécifique.
  • lang (par défaut : en) : Code de langue. Le contenu anglais est renvoyé dans cette version.
  • format (par défaut : json) : Utilisez json pour l’objet complet ou text pour une réponse en texte brut.

3. Affirmation aléatoire par catégorie

GET /v1/affirmations/categories/{category}/random

Paramètres :

  • category (requis) : La catégorie dans laquelle choisir, comme sleep. Les catégories inconnues renvoient un 404 clair.

4. Lister les catégories

GET /v1/affirmations/categories

Renvoie la liste complète et triée des catégories — de anxiety-relief et calm à confidence, focus, gratitude, parenting, resilience, self-love, sleep, success, et plus encore.

5. Affirmations par lot

GET /v1/affirmations/batch

Paramètres :

  • category (facultatif) : Filtrer le lot par catégorie.
  • limit (par défaut : 10) : Nombre d’affirmations à renvoyer, jusqu’à un maximum de 50.
  • lang (par défaut : en) : Code de langue. Le contenu anglais est renvoyé dans cette version.

6. L’affirmation du jour

GET /v1/affirmations/today

Paramètres :

  • category (facultatif) : Renvoyer la sélection quotidienne déterministe au sein d’une catégorie.
  • lang (par défaut : en) : Code de langue. Le contenu anglais est renvoyé dans cette version.

L’alias /daily renvoie la même affirmation du jour.

7. Personnaliser

POST /v1/affirmations/personalize

Corps :

  • mood (facultatif) : Humeur ou catégorie dans laquelle puiser, comme confidence. Par défaut happiness.
  • goal (facultatif) : L’intention derrière l’affirmation.
  • name (facultatif) : Un prénom à intégrer dans l’affirmation, par exemple “I am confident, Ava.”

8. Reformuler une pensée négative

POST /v1/affirmations/reframe

Corps :

  • negativeThought (requis) : La pensée à reformuler, par exemple “I always fail”.

Renvoie une déclaration reformulée accompagnée d’une affirmation de résilience correspondante.

9. Affirmation + ensemble de respiration

GET /v1/affirmations/bundle

Paramètres :

  • category (facultatif) : La catégorie dans laquelle puiser. La catégorie sleep renvoie l’exercice de respiration 4-7-8 ; toutes les autres catégories renvoient la respiration box.

10. Horaire suggéré

GET /v1/affirmations/schedule

Paramètres :

  • timezone (facultatif) : Libellé du fuseau horaire pour les créneaux suggérés, par exemple Europe/Berlin. Par défaut UTC.

📦 Exemples de réponses

Affirmation aléatoire :

{
  "id": 1874329517,
  "text": "I am confident, capable, and ready for today.",
  "category": "confidence",
  "mood": "confidence",
  "lang": "en",
  "length": 42
}

Affirmation personnalisée :

{
  "id": 55123874,
  "text": "I am confident, Ava.",
  "category": "confidence",
  "mood": "confidence",
  "lang": "en",
  "length": 20
}

Pensée reformulée :

{
  "reframe": "Even though \"I always fail\", I choose to believe: I am learning and growing every day.",
  "affirmation": {
    "id": 912345678,
    "text": "I am learning and growing every day.",
    "category": "resilience",
    "mood": "resilience",
    "lang": "en",
    "length": 36
  }
}

Ensemble de bien-être :

{
  "affirmation": {
    "id": 44556677,
    "text": "I release the day and welcome rest.",
    "category": "sleep",
    "mood": "sleep",
    "lang": "en",
    "length": 36
  },
  "breathing": {
    "name": "4-7-8",
    "steps": ["Inhale 4s", "Hold 7s", "Exhale 8s"]
  }
}

Horaire suggéré :

{
  "morning": "08:00 Europe/Berlin",
  "evening": "21:00 Europe/Berlin",
  "timezone": "Europe/Berlin"
}

✨ Réponses multi-formats

Le point de terminaison aléatoire parle à la fois JSON et texte brut. Utilisez ?format=json (par défaut) pour l’objet structuré complet dans les applications web et mobiles, ou ?format=text pour une chaîne prête à envoyer dans les flux SMS, les assistants vocaux et les widgets.

🎯 Conçu pour

  • Développeurs qui créent des applications de bien-être, des chatbots et des fonctionnalités de motivation et qui veulent une API stable et bien documentée.
  • Chefs de produit qui augmentent l’engagement grâce à des notifications quotidiennes, des séries et du contenu quotidien déterministe.
  • Créateurs d’applications de bien-être qui ont besoin d’un contenu d’affirmations fiable et catégorisé à grande échelle.
  • Équipes d’entreprise qui attendent des points de terminaison évolutifs de type SDK avec un onboarding prêt pour Postman.

🌟 Pourquoi choisir l’API Affirmations ?

  • Fiable par conception : des ID stables, des données épurées et des 404 clairs signifient moins de surprises en production.
  • De la profondeur quand vous en avez besoin : 19 catégories couvrant tout, du soulagement de l’anxiété à l’amour de soi.
  • Plus qu’un simple appel : personnalisation, reformulation, ensembles de respiration et planification dans une seule API.
  • Adaptée aux développeurs : recherche, pagination, traitement par lot, réponses multi-formats et extraits prêts à l’emploi.
  • Prête pour le bien-être : 99.99% de disponibilité avec des réponses à faible latence pour les moments positifs du quotidien.

🚀 Pour commencer

  • Collection Postman : Importez docs/affirmations-postman.json pour explorer chaque point de terminaison en un clic.
  • Extraits de code : Copiez des exemples prêts à exécuter pour cURL, JavaScript et Python depuis docs/affirmations-snippets.md.
  • Prêt pour les LLM : docs/llms.txt donne aux agents IA un résumé structuré de l’API.

Commencez à créer des moments positifs dès aujourd’hui — appelez le point de terminaison today pour obtenir une affirmation quotidienne déterministe, puis ajoutez la personnalisation et les ensembles de respiration pour compléter l’expérience de bien-être.