POST/api/astro/tarot/draw/1 кредит

Витягування карт Таро

Витягує карти з перетасованої колоди Rider-Waite-Smith із сімдесяти восьми карт. Карти витягуються без повернення, тож в одному витягуванні жодна не повторюється. Кожна карта повертається зі своїм арканом, мастю, рангом, номером, положенням і стандартними ключовими словами для того положення, у якому вона випала. Кожна відповідь містить `seed`, яким її отримано, і якщо надіслати це зерно назад, витягування відтвориться точно: ті самі карти, у тому самому порядку, тим самим боком догори. Якщо зерно не передати, його буде згенеровано й повернуто, тож за замовчуванням витягування нове, а повторити його згодом можна завжди. Саме це дає змогу клієнтові зберегти розклад і показати його знову, а не давати запитувачеві іншу відповідь на те саме запитання. `allow_reversed` і `reversal_chance` потрібні, бо тарологи працюють по-різному: одні — лише з прямими картами, інші перевертають близько половини колоди, а ще інші — значно менше.

https://api.occultapi.com/api/astro/tarot/draw/

Спробувати запит

Автентифікація

Передавайте ключ у заголовку X-API-Key. Ключ — це серверні облікові дані: ніколи не вставляйте його в JavaScript, що виконується в браузері, чи в мобільний застосунок.

X-API-Key: yt_live_a1b2c3d4_…
Content-Type: application/json

Поля запиту

Поле	Тип	Обов’язкове	Примітки
allow_reversed	boolean	необов’язковий	Чи можуть карти випадати перевернутими. Деякі тарологи працюють лише з прямими картами.
count	integer	необов’язковий	Скільки карт витягнути, не більше 21. Карти витягуються без повернення, тож жодна не повториться. min 1 · max 21
question	string	необов’язковий	Необов’язкове. Повертається у відповіді й ураховується під час генерування зерна.
reversal_chance	number (double)	необов’язковий	Імовірність перевернутої карти, якщо перевернуті карти дозволено. min 0 · max 1
seed	string	необов’язковий	Надішліть зерно, щоб точно відтворити витягування. Якщо його не передати, воно буде згенероване й повернуте, тож будь-яке витягування можна згодом повторити.

Приклад запиту

curl -X POST https://api.occultapi.com/api/astro/tarot/draw/ \
  -H "X-API-Key: $OCCULT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"What should I focus on this month?","count":3,"seed":"sample-draw"}'

Відповідь

{
  "data": {
    "question": "What should I focus on this month?",
    "seed": "sample-draw",
    "reproducible": "Send this seed back to get exactly this draw again.",
    "deck": "Rider-Waite-Smith, 78 cards",
    "reversals_allowed": true,
    "cards": [
      {
        "position": 1,
        "id": 50,
        "name": "Ace of Swords",
        "arcana": "minor",
        "suit": "Swords",
        "rank": "Ace",
        "number": 1,
        "element": "air",
        "upright": "clarity, breakthrough, truth cutting through",
        "reversed": "confusion, a truth misused",
        "orientation": "reversed",
        "meaning": "confusion, a truth misused",
        "yes_no": "no"
      },
      {
        "position": 2,
        "id": 32,
        "name": "Page of Wands",
        "arcana": "minor",
        "suit": "Wands",
        "rank": "Page",
        "number": 11,
        "element": "fire",
        "upright": "curiosity, an idea, enthusiasm",
        "reversed": "unfocused energy, an idea unformed",
        "orientation": "reversed",
        "meaning": "unfocused energy, an idea unformed",
        "yes_no": "no"
      },
      {
        "position": 3,
        "id": 31,
        "name": "Ten of Wands",
        "arcana": "minor",
        "suit": "Wands",
        "rank": "Ten",
        "number": 10,
        "element": "fire",
        "upright": "burden, overload, carrying too much",
        "reversed": "putting a load down, delegation",
        "orientation": "upright",
        "meaning": "burden, overload, carrying too much",
        "yes_no": "no"
      }
    ],
    "count": 3
  },
  "status": 200,
  "is_error": false,
  "message": "successful"
}

Записано з реального виклику з точно таким запитом, як вище. Результати лежать у data.

Помилки

Помилки обліку кредитів мають вигляд { "error": "…", "message": "<code>", "is_error": true }. Людям показуйте error, а логіку будуйте на message. Детальніше — у довіднику помилок.