Documentación de la API del Oráculo

Todo lo que necesitas para integrar perspectivas espirituales y lecturas de oráculo personalizadas en tus propias aplicaciones.

Documentation

Primeros pasos Autenticación Lecturas Regalos Códigos de Error

Primeros pasos

Conecta tus aplicaciones a Yes No Oracle con una sencilla API REST. Recupera tus lecturas, gestiona tu historial y ofrece lecturas como regalo, todo con unas pocas solicitudes JSON. Esta documentación cubre la autenticación, los endpoints disponibles y los códigos de error.

Todas las respuestas son JSON. Los endpoints autenticados requieren tu clave API personal como token Bearer.

Autenticación

Todos los endpoints autenticados requieren un encabezado Authorization que contenga tu clave API, la cual puedes generar desde la configuración de tu cuenta.

URL 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"

Mantén tu clave privada

Nunca expongas tu clave API en código del lado del cliente (navegador, aplicación móvil). Siempre realiza llamadas a la API desde un servidor seguro.

Lecturas

Recupera, actualiza o elimina lecturas guardadas en tu cuenta. Todos los endpoints requieren autenticación.

Listar Lecturas

Devuelve tus lecturas en orden cronológico inverso, con paginación basada en cursor.

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

Parameter	Type	Description
`limit`	number	Número de resultados por página (predeterminado: 50, máximo: 100).
`cursor`	string	Cursor de paginación — usa el valor nextCursor de la respuesta anterior.

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..."
}

Obtener una Lectura

Recupera una lectura individual por su ID.

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"
  }
}

Actualizar una Lectura

Actualiza la nota y/o el estado de ánimo de una lectura existente.

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

Parameter	Type	Description
`note`	string	Opcional. Nota personal adjunta a la lectura.
`mood`	string	Opcional. Etiqueta de estado de ánimo para la lectura.

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." }'

Eliminar una Lectura

Elimina permanentemente una lectura de tu cuenta.

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 } }

Regalos

Acceso Exclusivo

Envía lecturas de oráculo como regalos. Cada regalo genera un enlace único válido indefinidamente. Limitado a 3 regalos cada 24 horas.

Listar Regalos Recientes

Devuelve los regalos creados en las últimas 24 horas.

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..."
    }
  ]
}

Crear un Regalo

Genera un nuevo token de regalo para un tipo de lectura determinado.

readingTypeId	Lectura
`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	Requerido. El tipo de lectura a regalar (ver tabla arriba).
`message`	string	Opcional. Mensaje personal incluido con el regalo.

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..."
  }
}

Códigos de Error

La API del Oráculo usa códigos de estado HTTP estándar. Las respuestas de error siempre incluyen un campo error con un mensaje legible.

Code	Meaning
200	Solicitud exitosa.
201	Recurso creado exitosamente.
400	Solicitud incorrecta — parámetros faltantes o inválidos.
401	No autorizado — clave API faltante o inválida.
403	Prohibido — se requiere suscripción VIP.
404	Recurso no encontrado.
429	Límite de velocidad excedido.
500	Error interno del servidor.

JSON

{
  "error": "VIP subscription required"
}