Documentation de l'API Oracle

Tout ce qu'il vous faut pour intégrer des insights spirituels et des tirages oracle personnalisés dans vos propres applications.

Documentation

Premiers pas Authentification Tirages Cadeaux Codes d'erreur

Premiers pas

Connectez vos applications à Yes No Oracle grâce à une API REST simple. Récupérez vos tirages, gérez votre historique et offrez des tirages en cadeau, le tout en quelques requêtes JSON. Cette documentation couvre l'authentification, les endpoints disponibles et les codes d'erreur.

Toutes les réponses sont en JSON. Les endpoints authentifiés nécessitent votre clé API personnelle passée en tant que Bearer token.

Authentification

Tous les endpoints authentifiés requièrent un header Authorization contenant votre clé API, que vous pouvez générer depuis les paramètres de votre compte.

URL de base

TEXT

https://www.yes-no-oracle.com/api/v1

BASH

curl -X GET "https://www.yes-no-oracle.com/api/v1/readings" \
  -H "Authorization: Bearer yno_your_api_key"

Gardez votre clé secrète

N'exposez jamais votre clé API dans du code côté client (navigateur, application mobile). Effectuez toujours vos appels API depuis un serveur sécurisé.

Tirages

Récupérez, modifiez ou supprimez des tirages enregistrés sur votre compte. Tous les endpoints nécessitent une authentification.

Lister les tirages

Retourne vos tirages par ordre chronologique inverse, avec une pagination par curseur.

GEThttps://www.yes-no-oracle.com/api/v1/readings

Parameter	Type	Description
`limit`	number	Nombre de résultats par page (défaut : 50, max : 100).
`cursor`	string	Curseur de pagination — utilisez la valeur nextCursor de la réponse précédente.

BASH

curl "https://www.yes-no-oracle.com/api/v1/readings?limit=10" \
  -H "Authorization: Bearer yno_your_api_key"

JSON

{
  "data": [
    {
      "id": "clx...",
      "readingTypeId": "destiny",
      "cards": [...],
      "note": "This spoke to me deeply.",
      "mood": "inspired",
      "customTitle": null,
      "cardCount": 3,
      "createdAt": "2026-04-28T14:23:00.000Z"
    }
  ],
  "nextCursor": "clx..."
}

Obtenir un tirage

Récupère un tirage unique par son identifiant.

GEThttps://www.yes-no-oracle.com/api/v1/readings/:id

BASH

curl "https://www.yes-no-oracle.com/api/v1/readings/clx..." \
  -H "Authorization: Bearer yno_your_api_key"

JSON

{
  "data": {
    "id": "clx...",
    "readingTypeId": "love",
    "cards": [...],
    "note": null,
    "mood": "hopeful",
    "createdAt": "2026-04-28T14:23:00.000Z"
  }
}

Modifier un tirage

Met à jour la note et/ou l'humeur d'un tirage existant.

PATCHhttps://www.yes-no-oracle.com/api/v1/readings/:id

Parameter	Type	Description
`note`	string	Optionnel. Note personnelle attachée au tirage.
`mood`	string	Optionnel. Tag d'humeur pour le tirage.

BASH

curl -X PATCH "https://www.yes-no-oracle.com/api/v1/readings/clx..." \
  -H "Authorization: Bearer yno_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "note": "Updated thoughts." }'

Supprimer un tirage

Supprime définitivement un tirage de votre compte.

DELETEhttps://www.yes-no-oracle.com/api/v1/readings/:id

BASH

curl -X DELETE "https://www.yes-no-oracle.com/api/v1/readings/clx..." \
  -H "Authorization: Bearer yno_your_api_key"

JSON

{ "data": { "success": true } }

Cadeaux

Accès Exclusif

Offrez des tirages oracle en cadeau. Chaque cadeau génère un lien unique valide indéfiniment. Limité à 3 cadeaux par 24 heures.

Lister les cadeaux récents

Retourne les cadeaux créés dans les dernières 24 heures.

GEThttps://www.yes-no-oracle.com/api/v1/gifts

BASH

curl "https://www.yes-no-oracle.com/api/v1/gifts" \
  -H "Authorization: Bearer yno_your_api_key"

JSON

{
  "data": [
    {
      "id": "clx...",
      "readingTypeId": "love",
      "token": "a3f9b...",
      "sentAt": "2026-05-01T08:00:00.000Z",
      "isUsed": false,
      "recipientEmail": null,
      "url": "https://www.yes-no-oracle.com/gift/a3f9b..."
    }
  ]
}

Créer un cadeau

Génère un nouveau token de cadeau pour un type de tirage donné.

readingTypeId	Tirage
`destiny`	Destiny Reading
`love`	Love Reading
`guardian-angel`	Guardian Angel Reading
`life-purpose`	Life Purpose Reading
`relationship`	Relationship Reading
`fortune`	Fortune Reading
`guidance`	Guidance Reading
`health`	Health Reading

POSThttps://www.yes-no-oracle.com/api/v1/gifts

Parameter	Type	Description
`readingTypeId`required	string	Requis. Le type de tirage à offrir (voir tableau ci-dessus).
`message`	string	Optionnel. Message personnel inclus avec le cadeau.

BASH

curl -X POST "https://www.yes-no-oracle.com/api/v1/gifts" \
  -H "Authorization: Bearer yno_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "readingTypeId": "love",
    "message": "Thinking of you — here is a little something."
  }'

JSON

{
  "data": {
    "id": "clx...",
    "token": "a3f9b...",
    "readingTypeId": "love",
    "sentAt": "2026-05-01T09:00:00.000Z",
    "url": "https://www.yes-no-oracle.com/gift/a3f9b..."
  }
}

Codes d'erreur

L'API Oracle utilise les codes HTTP standard. Les réponses d'erreur contiennent toujours un champ error avec un message lisible.

Code	Meaning
200	Requête réussie.
201	Ressource créée avec succès.
400	Requête invalide — paramètres manquants ou incorrects.
401	Non autorisé — clé API manquante ou invalide.
403	Interdit — abonnement VIP requis.
404	Ressource introuvable.
429	Limite de taux dépassée.
500	Erreur interne du serveur.

JSON

{
  "error": "VIP subscription required"
}