Preskočiť na obsah
API pre vývojárov

Vytváraj aktivity z vlastného systému

Jeden POST na každý typ aktivity. Pošli svoj obsah ako JSON a späť dostaneš aktivitu vo svojom účte Puzzel.org a URL, ktorú odovzdáš hráčom alebo vložíš do iframe.

Základná URL
https://puzzel.org/api/public/v1
Overenie
Kľúč + e-mail v tele
Koncové body
38 typov aktivít
Kvóta
10 aktivít denne

Tvoja prvá požiadavka

Nič sa neinštaluje a žiadny handshake: pošli telo v JSON so svojím kľúčom, e-mailom a obsahom. Odpoveď obsahuje kľúč novej aktivity a URL, na ktorej sa hrá.

POST crossword 
curl -X POST https://puzzel.org/api/public/v1/crossword \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Crossword",
  "language": "sk",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}

Každý príklad na tejto stránke je úplná, spustiteľná požiadavka. Doplň vlastný kľúč a obsah a funguje tak, ako je.

Overenie totožnosti

Žiadne hlavičky, žiadny bearer token. Oba údaje cestujú v tele JSON každej požiadavky a kľúč sa prijme len pre účet, ktorému daný e-mail patrí.

PoleTypČo robí
account_api_key
povinné
string
stringKľúč API tvojho účtu. Patrí do tela, nie do hlavičky.
email
povinné
string
stringAdresa, ktorou sa prihlasuje tvoj účet Puzzel.org. Kľúč platí len spolu s ňou.

Kľúč nájdeš v sekcii účtu vo svojom prehľade, pod tlačidlom Zobraziť.

Prihlásiť sa

Kľúče API sa vydávajú pri spustení predplatného, takže bezplatný účet zatiaľ žiadny nemá.

Pozrieť plány

Ku kľúču sa správaj ako k heslu. Vytvára a prepisuje aktivity v tvojom účte, tak ho drž na serveri a mimo všetkého, čo si prehliadač vie prečítať.

Telo požiadavky

Každý koncový bod berie rovnakých päť polí. Líši sa až pole s obsahom pod nimi: väčšina berie pole položiek, zopár jednu vetu alebo jeden obrázok a sudoku neberie nič.

PoleTypČo robí
account_api_key
povinné
string
stringKľúč API tvojho účtu. Patrí do tela, nie do hlavičky.
email
povinné
string
stringAdresa, ktorou sa prihlasuje tvoj účet Puzzel.org. Kľúč platí len spolu s ňou.
title
voliteľné
string
stringNázov, ktorý aktivita dostane v tvojom prehľade. Ak ho vynecháš, koncový bod použije svoj náhradný názov.
language
voliteľné
string
stringUrčuje len jazyk v URL, ktorú dostaneš späť — nič z toho, čo pošleš, nepreloží. Osemsmerovka ho navyše číta, aby pri hodnote "ar" prepla výplňové písmená na arabské.
Predvolené: "en"
activity_key
voliteľné
string
stringAk ho vynecháš, vytvorí sa nová aktivita. Ak pošleš kľúč aktivity, ktorú už vlastníš, prestaví sa namiesto toho tá.

settings je objekt s možnosťami pre daný koncový bod. Ktoré z nich koncový bod číta, je uvedené pri ňom nižšie; čokoľvek iné, čo tam dáš, sa ignoruje.

Čo príde späť

Úspešné volanie odpovie kódom 200 s kľúčom novej aktivity a URL, na ktorej sa hrá. Čokoľvek iné odpovie s success nastaveným na false a jediným reťazcom error.

Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}
Zlyhanie 
{
  "success": false,
  "error": "Invalid Email or API Key"
}

url, ktorú dostaneš späť, je zobrazenie embed. Vymeň embed za play a otvorí sa na celú stránku, alebo za build a otvorí sa v editore — kľúč za p= zostáva rovnaký.

Vytváranie vs. aktualizácia

Pošli activity_key a aktivita za ním sa prestaví na mieste: jej obsah sa nahradí, názov a značka verzie sa obnovia a samotný kľúč zostane rovnaký — takže už zdieľané odkazy a vloženia fungujú ďalej. Výsledky, umiestnenie v priečinku a každé nastavenie, ktoré koncový bod sám nezapisuje, zostanú tak, ako boli.

activity_key 
{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "activity_key": "-Nq8sample_activity_key",
  "title": "Fruit crossword, week 2",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ]
}
  • title sa uplatní pri každej aktualizácii, vrátane svojej predvolenej hodnoty — ak ho vynecháš, aktivita sa premenuje na náhradný názov daného koncového bodu.
  • Bloky nastavení, ktoré koncový bod zapisuje sám, sa prepíšu odznova, takže aktualizácia ich zároveň vráti na hodnoty, ktoré pošleš, alebo na predvolené hodnoty koncového bodu.
  • Aktualizovať sa dajú len aktivity, ktoré vlastní tvoj účet. Cudzí kľúč odpovie kódom 403.
  • Aktualizácia stojí rovnako ako vytvorenie: jedno volanie z dnešnej kvóty.

Limit počtu volaní

10
10 aktivít na účet a deň

Počíta sa každé úspešné volanie, vytvorenie aj aktualizácia. Po prekročení odpovie ďalšia požiadavka kódom 429, kým sa počítadlo nevynuluje.

Počítadlo raz denne vynuluje naplánovaná úloha, nie kĺzavé 24-hodinové okno.

Chyby

Chyby prichádzajú vždy ako JSON s tými istými dvoma poľami, nikdy ako HTML stránka. Reťazec error je napísaný tak, aby ho čítal človek — pomenúva pole alebo limit, ktorý zlyhal.

StavČo znamená
400
Bad Request
V tele niečo chýba, má zlý tvar alebo je mimo rozsahu. Správa pomenúva dané pole.
401
Unauthorized
E-mail je neznámy alebo kľúč nepatrí k tomu účtu.
403
Forbidden
Odoslaný activity_key patrí inému účtu.
429
Too Many Requests
Dnešná kvóta je vyčerpaná. Vynuluje sa raz denne.
500
Server Error
Generátor nedokázal z odoslaného obsahu zostaviť hlavolam — zvyčajne je slov príliš málo alebo sa nedajú pospájať.

Koncové body

Jedna cesta na každý typ aktivity, všetky POST, všetky pod rovnakou základnou URL. Pri každej je uvedený obsah, ktorý potrebuje, nastavenia, ktoré číta, a požiadavka, ktorú si vieš spustiť.

Slová a písmená

Krížovka

Poprepája tvoje odpovede do mriežky a definície ti očísluje.

#
POST /api/public/v1/crossword 2 až 80 v items
Obsah

Pole slov. Každá položka spája odpoveď s definíciou, ktorá na ňu ukazuje.

Náhradný názov je “Crossword API”

Dobré vedieť
  • Odpovede kratšie ako dva znaky sa pred zostavením mriežky vyradia a aspoň dve to musia prežiť.
  • Odpovede sa prevedú na veľké písmená a generátor má dvadsať pokusov, aby ich umiestnil. Ak nedokáže umiestniť ani jedno slovo, volanie odpovie kódom 500.
Nastavenia, ktoré číta
PoleTypČo robí
hidden_solution
voliteľné v settings
string
stringVoliteľné bonusové slovo. Jeho písmená sú označené v políčkach hotovej mriežky, aby ich hráči po vyriešení krížovky pozbierali, takže každé jeho písmeno sa musí objaviť v odpovediach.
Ukážková požiadavka
POST crossword 
curl -X POST https://puzzel.org/api/public/v1/crossword \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Crossword",
  "language": "sk",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}
Otvoriť editor Späť nahor

Osemsmerovka

Skryje tvoje slová do mriežky písmen, v smeroch a tvare, ktoré si vyberieš.

#
POST /api/public/v1/wordseeker 2 až 40 v items
Obsah

Pole slov. Text definície sa stane zoznamom slov, s ktorým hráči pracujú.

Náhradný názov je “Wordseeker API”

Dobré vedieť
  • Odpovede kratšie ako dva znaky sa vyradia a každá odpoveď sa pred vložením do mriežky prevedie na veľké písmená.
  • Mriežka sa dopĺňa latinkovými písmenami, kým language nie je "ar", čo prepne výplň na arabskú.
Nastavenia, ktoré číta
PoleTypČo robí
hidden_solution
voliteľné v settings
string
stringZvyšné písmená vyskladajú práve toto. Nastavením zároveň generátoru povieš, aby najprv umiestnil riešenie a nesnažil sa napchať čo najviac slov.
directions
voliteľné v settings
string[]
string[]Ktorými smermi môže slovo viesť. Ak to vynecháš, slová idú len na východ, juhovýchod a juh.
Jedno z westeastnorthsouthnorthwestnortheastsouthwestsoutheast
Predvolené: ["east", "southeast", "south"]
template
voliteľné v settings
string
stringVyreže mriežku do tvaru namiesto toho, aby zostala štvorcová.
Jedno z squarecirclecrossdiamondpyramidsmileystarcross_plus
Ukážková požiadavka
POST wordseeker 
curl -X POST https://puzzel.org/api/public/v1/wordseeker \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Wordseeker",
  "language": "sk",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ],
  "settings": {
    "hidden_solution": "FRUIT",
    "directions": [
      "east",
      "south",
      "southeast"
    ],
    "template": "square"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/wordseeker/embed?p=-Nq8sample_activity_key",
  "message": "Wordseeker created successfully"
}
Otvoriť editor Späť nahor

Akrostich

Naskladá tvoje odpovede tak, aby jeden stĺpec vyskladal skryté slovo.

#
POST /api/public/v1/acrostic 1 až 40 v items
Obsah

Pole slov. Dohromady musia dodať každé písmeno skrytého slova.

Náhradný názov je “Acrostic API”

Dobré vedieť
  • Ak odpovede nedokážu dodať písmená, ktoré riešenie potrebuje, volanie odpovie kódom 500, namiesto toho aby uložilo napoly zostavenú mriežku.
  • Generátor tvoje odpovede preusporiada, aby stĺpec vyšiel, takže poradie, v ktorom ich pošleš, nie je poradie, ktoré vidia hráči.
Nastavenia, ktoré číta
PoleTypČo robí
hidden_solution
povinné v settings
string
stringSlovo, ktoré vyskladá zvýraznený stĺpec. Bez neho tento koncový bod nezbehne.
Ukážková požiadavka
POST acrostic 
curl -X POST https://puzzel.org/api/public/v1/acrostic \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Acrostic",
  "language": "sk",
  "items": [
    {
      "answer": "PEACH",
      "description": "Fuzzy skin, sweet flesh",
      "type": "text"
    },
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ],
  "settings": {
    "hidden_solution": "PLUM"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/acrostic/embed?p=-Nq8sample_activity_key",
  "message": "Acrostic created successfully"
}
Otvoriť editor Späť nahor

Pomiešané písmená

api_e_word_scramble

#
POST /api/public/v1/word-scramble 1 až 40 v items
Obsah

api_c_word_scramble

Náhradný názov je “Word Scramble API”

Dobré vedieť
  • Aktivity vytvorené cez API majú vždy zapnuté nastavenie na premiešanie poradia, takže poradie, v ktorom ich pošleš, nie je poradie, ktoré dostanú hráči.
Nastavenia, ktoré číta
PoleTypČo robí
hidden_solution
voliteľné v settings
string
stringVoliteľné bonusové slovo, ktoré hráči zadajú, keď vyriešia zvyšok.
Ukážková požiadavka
POST word-scramble 
curl -X POST https://puzzel.org/api/public/v1/word-scramble \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Word Scramble",
  "language": "sk",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    },
    {
      "answer": "CHERRY",
      "description": "A small red stone fruit",
      "type": "text"
    },
    {
      "answer": "MELON",
      "description": "Big, green outside, sweet inside",
      "type": "text"
    }
  ],
  "settings": {
    "hidden_solution": "FRUIT"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/word-scramble/embed?p=-Nq8sample_activity_key",
  "message": "Word Scramble created successfully"
}
Otvoriť editor Späť nahor

Obesenec

Zmení tvoje slová alebo slovné spojenia na kolá s hádaním písmen.

#
POST /api/public/v1/hangman 1 až 50 v items
Obsah

Pole slov alebo krátkych slovných spojení. Indícia je tip, ktorý hráči vidia.

Náhradný názov je “Hangman API”

Ukážková požiadavka
POST hangman 
curl -X POST https://puzzel.org/api/public/v1/hangman \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Hangman",
  "language": "sk",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/hangman/embed?p=-Nq8sample_activity_key",
  "message": "Hangman created successfully"
}
Otvoriť editor Späť nahor

Wordle

Z každého slova, ktoré pošleš, spraví hru na hádanie slova.

#
POST /api/public/v1/wordle 1 až 50 v items
Obsah

Pole slov. Hráči dostanú jedno kolo na každé slovo.

Náhradný názov je “Wordle API”

Dobré vedieť
  • Vytvorí sa so zapnutým nastavením na kontrolu, či sú hádané slová skutočné. Ak sú tvoje slová mená alebo vymyslené, vypni ho v editore.
Ukážková požiadavka
POST wordle 
curl -X POST https://puzzel.org/api/public/v1/wordle \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Wordle",
  "language": "sk",
  "items": [
    {
      "answer": "MELON",
      "description": "Sweet and green",
      "type": "text"
    },
    {
      "answer": "PEACH",
      "description": "Fuzzy and orange",
      "type": "text"
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/wordle/embed?p=-Nq8sample_activity_key",
  "message": "Wordle created successfully"
}
Otvoriť editor Späť nahor

Nácvik písania

api_e_typing_practice

#
POST /api/public/v1/typing-practice 1 až 50 v items
Obsah

api_c_typing_practice

Náhradný názov je “Typing Practice API”

Ukážková požiadavka
POST typing-practice 
curl -X POST https://puzzel.org/api/public/v1/typing-practice \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Typing Practice",
  "language": "sk",
  "items": [
    {
      "answer": "The quick brown fox jumps over the lazy dog",
      "description": "Every letter of the alphabet",
      "type": "text"
    },
    {
      "answer": "Pack my box with five dozen liquor jugs",
      "description": "Another pangram",
      "type": "text"
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/typing-practice/embed?p=-Nq8sample_activity_key",
  "message": "Typing Practice created successfully"
}
Otvoriť editor Späť nahor

Koleso šťastia

api_e_wheel_of_fortune

#
POST /api/public/v1/wheel-of-fortune 1 až 50 v items
Obsah

api_c_wheel_of_fortune

Náhradný názov je “Wheel of Fortune API”

Dobré vedieť
  • Vytvorí sa s nastavením “zobraziť výsledok len v kolese”, takže výsledok sa číta z kolesa a neoznamuje sa vedľa neho.
Ukážková požiadavka
POST wheel-of-fortune 
curl -X POST https://puzzel.org/api/public/v1/wheel-of-fortune \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Wheel of Fortune",
  "language": "sk",
  "items": [
    {
      "answer": "Read a page aloud",
      "description": "Segment 1",
      "type": "text"
    },
    {
      "answer": "Name three fruits",
      "description": "Segment 2",
      "type": "text"
    },
    {
      "answer": "Spell it backwards",
      "description": "Segment 3",
      "type": "text"
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/wheel-of-fortune/embed?p=-Nq8sample_activity_key",
  "message": "Wheel of Fortune created successfully"
}
Otvoriť editor Späť nahor

Švédska krížovka

Švédska krížovka: definície sú priamo v mriežke a každá má šípku k svojej odpovedi.

#
POST /api/public/v1/arrowword 2 až 80 v items
Obsah

Pole slov. Každá položka spája odpoveď s definíciou, ktorá je dosť krátka, aby sa zmestila do jedného políčka.

Náhradný názov je “Arrowword API”

Nastavenia, ktoré číta
PoleTypČo robí
hidden_solution
voliteľné v settings
string
stringVoliteľné bonusové slovo. Jeho písmená sú označené v políčkach hotovej mriežky, takže každé jeho písmeno sa musí objaviť v odpovediach.
Ukážková požiadavka
POST arrowword 
curl -X POST https://puzzel.org/api/public/v1/arrowword \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Arrowword",
  "language": "sk",
  "items": [
    {
      "answer": "Stockholm",
      "description": "Capital of Sweden",
      "type": "text"
    },
    {
      "answer": "Oslo",
      "description": "Capital of Norway",
      "type": "text"
    },
    {
      "answer": "Helsinki",
      "description": "Capital of Finland",
      "type": "text"
    }
  ],
  "settings": {
    "hidden_solution": "North"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/arrowword/embed?p=-Nq8sample_activity_key",
  "message": "Arrowword created successfully"
}
Otvoriť editor Späť nahor

Strands

Mriežka, v ktorej každé písmeno patrí k tematickému slovu, pričom jedno slovo, ktoré pomenúva tému, vedie od okraja k okraju.

#
POST /api/public/v1/strands 2 až 24 v items
Obsah

Pole tematických slov. Spolu so spangramom musia ich písmená presne vyplniť mriežku.

Náhradný názov je “Strands API”

Dobré vedieť
  • Písmená všetkých slov a spangramu dokopy musia dať presne 30, 35, 36, 40, 42, 45, 48, 49, 50, 54, 56, 60, 63, 64, 70, 72 alebo 80. Akýkoľvek iný počet odpovie kódom 400 a povie, koľko písmen pridať alebo ubrať.
Nastavenia, ktoré číta
PoleTypČo robí
theme
voliteľné v settings
string
stringHádanka zobrazená nad mriežkou. Ak ju vynecháš, hráči uvidia názov.
spangram
voliteľné v settings
string
stringSlovo alebo slovné spojenie, ktoré pomenúva tému a prechádza mriežkou od jedného okraja k druhému.
Ukážková požiadavka
POST strands 
curl -X POST https://puzzel.org/api/public/v1/strands \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Strands",
  "language": "sk",
  "items": [
    {
      "answer": "whisk",
      "type": "text"
    },
    {
      "answer": "ladle",
      "type": "text"
    },
    {
      "answer": "spatula",
      "type": "text"
    },
    {
      "answer": "grater",
      "type": "text"
    },
    {
      "answer": "peeler",
      "type": "text"
    },
    {
      "answer": "skillet",
      "type": "text"
    }
  ],
  "settings": {
    "theme": "What the cook reaches for",
    "spangram": "Kitchen tools"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/strands/embed?p=-Nq8sample_activity_key",
  "message": "Strands created successfully"
}
Otvoriť editor Späť nahor

Vymenúvačka

api_e_name_them_all

#
POST /api/public/v1/name-them-all 1 až 250 v items
Obsah

api_c_name_them_all

Náhradný názov je “Name Them All API”

Dobré vedieť
  • Položka je objekt s poľom answer a voliteľne aliases (iné pravopisy, ktoré sa uznajú), description (tip) a group. Pri kontrole názvu sa ignorujú veľké písmená, diakritika a interpunkcia.
Nastavenia, ktoré číta
PoleTypČo robí
list_match_mode
voliteľné v settings
string
stringČi sa názov uzná v okamihu, keď ho hráč napíše, alebo až po stlačení klávesu Enter.
Jedno z while_typingon_enter
Predvolené: "while_typing"
list_slot_hint
voliteľné v settings
string
stringČo prezradí prázdne políčko: nič, dĺžku názvu, jeho prvé písmeno alebo tip, ktorý napíšeš.
Jedno z nonelengthfirst_letterhint
Predvolené: "none"
list_arrange
voliteľné v settings
string
stringJeden stĺpec na skupinu, alebo jeden zoznam.
Jedno z groupsone_list
Predvolené: "groups"
list_allow_give_up
voliteľné v settings
boolean
booleanZobrazí tlačidlo na vzdanie, ktoré ukončí pokus a odhalí, čo hráč vynechal.
Predvolené: false
Ukážková požiadavka
POST name-them-all 
curl -X POST https://puzzel.org/api/public/v1/name-them-all \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Name Them All",
  "language": "sk",
  "items": [
    {
      "answer": "United Kingdom",
      "aliases": [
        "UK",
        "Great Britain",
        "Britain"
      ],
      "group": "Islands"
    },
    {
      "answer": "Ireland",
      "aliases": [
        "Éire"
      ],
      "group": "Islands"
    },
    {
      "answer": "Côte d'Azur's neighbour Monaco",
      "aliases": [
        "Monaco"
      ],
      "description": "The smallest one",
      "group": "Mainland"
    }
  ],
  "settings": {
    "list_slot_hint": "first_letter",
    "list_match_mode": "on_enter",
    "list_allow_give_up": true
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/name-them-all/embed?p=-Nq8sample_activity_key",
  "message": "Name them all list created successfully"
}
Otvoriť editor Späť nahor
Karty a dvojice

Memory

Karty otočené lícom nadol, ktoré sa otáčajú a párujú do dvojíc.

#
POST /api/public/v1/memory 2 až 30 v items
Obsah

Pole dvojíc. Každá dvojica obsahuje dve karty, ktoré patria k sebe.

Náhradný názov je “Memory Game API”

Dobré vedieť
  • Karta je objekt s poľom type a value. Pre slová použi "text", alebo "image", "audio", "youtube" či "link" s URL v poli value, a pre popis pridaj alt.
Ukážková požiadavka
POST memory 
curl -X POST https://puzzel.org/api/public/v1/memory \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Memory Game",
  "language": "sk",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "Apple"
        },
        {
          "type": "text",
          "value": "A red fruit"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "A yellow fruit"
        }
      ]
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/memory/embed?p=-Nq8sample_activity_key",
  "message": "Memory game created successfully"
}
Otvoriť editor Späť nahor

Priraď k sebe

api_e_matching_pairs

#
POST /api/public/v1/matching-pairs 2 až 30 v items
Obsah

api_c_matching_pairs

Náhradný názov je “Matching Game API”

Dobré vedieť
  • Karta je objekt s poľom type a value. Pre slová použi "text", alebo "image", "audio", "youtube" či "link" s URL v poli value, a pre popis pridaj alt.
Ukážková požiadavka
POST matching-pairs 
curl -X POST https://puzzel.org/api/public/v1/matching-pairs \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Matching Game",
  "language": "sk",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "Apple"
        },
        {
          "type": "text",
          "value": "A red fruit"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "A yellow fruit"
        }
      ]
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/matching-pairs/embed?p=-Nq8sample_activity_key",
  "message": "Matching pairs game created successfully"
}
Otvoriť editor Späť nahor

Kartičky na učenie

api_e_flash_cards

#
POST /api/public/v1/flash-cards 1 až 150 v items
Obsah

api_c_flash_cards

Náhradný názov je “Flash Cards API”

Dobré vedieť
  • Koncový bod uloží toľko kariet, koľko ich pošleš, tak posielaj presne dve na položku — najprv prednú, potom zadnú.
  • Karta je objekt s poľom type a value. Pre slová použi "text", alebo "image", "audio", "youtube" či "link" s URL v poli value, a pre popis pridaj alt.
Ukážková požiadavka
POST flash-cards 
curl -X POST https://puzzel.org/api/public/v1/flash-cards \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Flash Cards",
  "language": "sk",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "Apple"
        },
        {
          "type": "text",
          "value": "A red fruit"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "A yellow fruit"
        }
      ]
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/flash-cards/embed?p=-Nq8sample_activity_key",
  "message": "Flash Cards created successfully"
}
Otvoriť editor Späť nahor

Triedenie do kategórií

Karty na roztriedenie do kategórie, kam patria.

#
POST /api/public/v1/categorize Aspoň 2 v items · najviac 60 kariet spolu
Obsah

Pole kategórií, každá s názvom a kartami, ktoré do nej patria.

Náhradný názov je “Categorize Game API”

Dobré vedieť
  • Kategória poslaná bez názvu sa uloží ako “Untitled Category”, tak vždy nejaký pošli.
  • Karta je objekt s poľom type a value. Pre slová použi "text", alebo "image", "audio", "youtube" či "link" s URL v poli value, a pre popis pridaj alt.
Ukážková požiadavka
POST categorize 
curl -X POST https://puzzel.org/api/public/v1/categorize \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Categorize Game",
  "language": "sk",
  "items": [
    {
      "name": "Red fruits",
      "cards": [
        {
          "type": "text",
          "value": "Strawberry"
        },
        {
          "type": "text",
          "value": "Cherry"
        }
      ]
    },
    {
      "name": "Yellow fruits",
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "Lemon"
        }
      ]
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/categorize/embed?p=-Nq8sample_activity_key",
  "message": "Categorize game created successfully"
}
Otvoriť editor Späť nahor

Zoraďovačka

Postupnosť, ktorú musia hráči dať späť do správneho poradia.

#
POST /api/public/v1/reorder Aspoň 1 v items · najviac 60 kariet spolu
Obsah

Pole postupností. Každá obsahuje svoje karty v správnom poradí.

Náhradný názov je “Reorder Game API”

Dobré vedieť
  • Poradie, v ktorom ich pošleš, sa uloží ako správne poradie — prvé je číslo jeden.
  • Karta je objekt s poľom type a value. Pre slová použi "text", alebo "image", "audio", "youtube" či "link" s URL v poli value, a pre popis pridaj alt.
Ukážková požiadavka
POST reorder 
curl -X POST https://puzzel.org/api/public/v1/reorder \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Reorder Game",
  "language": "sk",
  "items": [
    {
      "name": "From seed to fruit",
      "cards": [
        {
          "type": "text",
          "value": "Plant the seed"
        },
        {
          "type": "text",
          "value": "Water it"
        },
        {
          "type": "text",
          "value": "Watch it grow"
        },
        {
          "type": "text",
          "value": "Pick the fruit"
        }
      ]
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/reorder/embed?p=-Nq8sample_activity_key",
  "message": "Reorder game created successfully"
}
Otvoriť editor Späť nahor

Bingo

Triedne bingo, ktoré moderátor vyvoláva naživo: každý hráč dostane kartu poskladanú z tvojich položiek.

#
POST /api/public/v1/bingo Neberie žiadne items
Obsah

Pole položiek, z ktorých sa karty skladajú. Pošli jasne viac položiek, než má jedna karta políčok, aby sa karty líšili.

Náhradný názov je “Bingo API”

Dobré vedieť
  • Položka je objekt s poľom value a voliteľne type ("text", "image" alebo "audio" s URL v poli value), description (indícia, ktorú moderátor prečíta v režime indícií) a alt.
Nastavenia, ktoré číta
PoleTypČo robí
mode
voliteľné v settings
string
stringČo vypĺňa políčka: tvoje položky, tvoje položky vylosované podľa ich indície, alebo obyčajné čísla (tie nepotrebujú žiadne items).
Jedno z itemscluesnumbers
Predvolené: "items"
rows
voliteľné v settings
number
numberRiadky na každej karte, 2 až 5.
Predvolené: 3
columns
voliteľné v settings
number
numberStĺpce na každej karte, 2 až 5.
Predvolené: 3
highest_number
voliteľné v settings
number
numberV režime čísel sa karty plnia od 1 až po toto číslo, najviac 100. Funkcia plánu: bez plánu zostáva 50.
Predvolené: 50
Ukážková požiadavka
POST bingo 
curl -X POST https://puzzel.org/api/public/v1/bingo \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Bingo",
  "language": "sk",
  "items": [
    {
      "type": "text",
      "value": "Paris",
      "description": "The capital of France"
    },
    {
      "type": "text",
      "value": "Berlin",
      "description": "The capital of Germany"
    },
    {
      "type": "text",
      "value": "Madrid",
      "description": "The capital of Spain"
    }
  ],
  "settings": {
    "mode": "clues",
    "rows": 3,
    "columns": 4,
    "highest_number": 75
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/bingo/embed?p=-Nq8sample_activity_key",
  "message": "Bingo created successfully"
}
Otvoriť editor Späť nahor

Ja mám, kto má

api_e_i_have_who_has

#
POST /api/public/v1/i-have-who-has 3 až 40 v items
Obsah

api_c_i_have_who_has

Náhradný názov je “I Have, Who Has API”

Dobré vedieť
  • Žiadna otázka ani odpoveď sa nesmie objaviť dvakrát: žiak, ktorý drží odpoveď, by nepoznal, ku ktorej otázke patrí.
Nastavenia, ktoré číta
PoleTypČo robí
chain_shape
voliteľné v settings
string
stringSlučka sa uzatvára sama do seba, takže môže začať ktorákoľvek karta; priamka sa otvára kartou Štart a končí kartou Koniec.
Jedno z loopline
Predvolené: "loop"
Ukážková požiadavka
POST i-have-who-has 
curl -X POST https://puzzel.org/api/public/v1/i-have-who-has \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "I Have, Who Has",
  "language": "sk",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "3 × 4"
        },
        {
          "type": "text",
          "value": "12"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "6 × 7"
        },
        {
          "type": "text",
          "value": "42"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "9 × 9"
        },
        {
          "type": "text",
          "value": "81"
        }
      ]
    }
  ],
  "settings": {
    "chain_shape": "line"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/i-have-who-has/embed?p=-Nq8sample_activity_key",
  "message": "I have, who has created successfully"
}
Otvoriť editor Späť nahor

Číselný zámok

Číselný zámok: panel kariet, z ktorých niektoré dokopy tvoria kód.

#
POST /api/public/v1/keypad 1 až 30 v items
Obsah

Pole kariet. Karty, ktoré patria do kódu, nesú svoje miesto v ňom.

Náhradný názov je “Keypad API”

Dobré vedieť
  • Karta je objekt s poľom value a voliteľne type ("text", "image" alebo "audio" s URL v poli value), alt a code_position: jej miesto v kóde, 1 je prvé. Karta môže byť v kóde len raz a aspoň jedna karta v ňom byť musí.
Nastavenia, ktoré číta
PoleTypČo robí
instructions
voliteľné v settings
string
stringOtázka alebo hádanka, na ktorú kód odpovedá, zobrazená spolu s panelom.
force_solution_in_correct_order
voliteľné v settings
boolean
booleanKarty treba stláčať v poradí. Keď je to vypnuté, zámok otvorí ľubovoľné poradie správnych kariet.
Predvolené: false
randomize_order
voliteľné v settings
boolean
booleanKaždý hráč dostane karty v pomiešanom usporiadaní.
Predvolené: true
Ukážková požiadavka
POST keypad 
curl -X POST https://puzzel.org/api/public/v1/keypad \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Keypad",
  "language": "sk",
  "items": [
    {
      "type": "text",
      "value": "4"
    },
    {
      "type": "text",
      "value": "7",
      "code_position": 2
    },
    {
      "type": "text",
      "value": "9"
    },
    {
      "type": "text",
      "value": "2",
      "code_position": 1
    }
  ],
  "settings": {
    "instructions": "Press the prime numbers, smallest first.",
    "force_solution_in_correct_order": true,
    "randomize_order": false
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/keypad/embed?p=-Nq8sample_activity_key",
  "message": "Keypad created successfully"
}
Otvoriť editor Späť nahor

Kvarteto

Kartová hra: hráči sa jeden druhého pýtajú na karty, aby zbierali štvorice.

#
POST /api/public/v1/quartets 2 až 16 v items
Obsah

Pole kvartet. Každé má názov a presne štyri karty.

Náhradný názov je “Quartets API”

Dobré vedieť
  • Karta je názov, alebo objekt s názvom a description (fakt zobrazený na nej). Žiadny názov karty sa nesmie v hre objaviť dvakrát: hráči si pýtajú karty podľa názvu.
Nastavenia, ktoré číta
PoleTypČo robí
type
voliteľné v settings
string
stringObyčajná hra, alebo učebná hra, v ktorej každá karta ukazuje fakt. Ak to vynecháš, je to learn, keď má niektorá karta description.
Jedno z normallearn
Ukážková požiadavka
POST quartets 
curl -X POST https://puzzel.org/api/public/v1/quartets \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Quartets",
  "language": "sk",
  "items": [
    {
      "name": "Birds",
      "cards": [
        {
          "name": "Owl",
          "description": "Hunts at night and turns its head three quarters of the way round."
        },
        {
          "name": "Robin",
          "description": "Sings through the winter."
        },
        {
          "name": "Woodpecker",
          "description": "Drums on trees up to twenty times a second."
        },
        {
          "name": "Jay",
          "description": "Buries thousands of acorns each autumn."
        }
      ]
    },
    {
      "name": "Mammals",
      "cards": [
        {
          "name": "Hedgehog",
          "description": "Carries about five thousand spines."
        },
        {
          "name": "Fox",
          "description": "Hears a mouse under the snow."
        },
        {
          "name": "Badger",
          "description": "Lives in a sett with its clan."
        },
        {
          "name": "Otter",
          "description": "Sleeps holding hands so it does not drift off."
        }
      ]
    }
  ],
  "settings": {
    "type": "learn"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/quartets/embed?p=-Nq8sample_activity_key",
  "message": "Quartets game created successfully"
}
Otvoriť editor Späť nahor
Otázky a odpovede

Kvíz

Otázky s výberom aj otvorené otázky, bodované priebežne.

#
POST /api/public/v1/quiz 1 až 100 v items
Obsah

Pole otázok. Otázky s výberom nesú svoje odpovede; otvorené otázky nesú odpoveď, ktorú uznáš.

Náhradný názov je “Quiz API”

Dobré vedieť
  • question_type je buď "multiple_choice", kde má správna možnosť isCorrect true, "true_false", teda to isté s presne dvoma možnosťami, najprv true a potom false, alebo "open_answer", ktorý namiesto toho používa correct_answer. Ak chýba, berie sa ako otázka s výberom.
  • Koncový bod kvízu posiela settings priamo ďalej ako bloky nastavení aktivity, takže to nie je miesto pre voľné možnosti — kvíz potom uprav v editore.
Ukážková požiadavka
POST quiz 
curl -X POST https://puzzel.org/api/public/v1/quiz \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Quiz",
  "language": "sk",
  "items": [
    {
      "question_type": "multiple_choice",
      "description": "Which fruit is yellow?",
      "answers": [
        {
          "type": "text",
          "description": "Banana",
          "isCorrect": true
        },
        {
          "type": "text",
          "description": "Cherry",
          "isCorrect": false
        }
      ]
    },
    {
      "question_type": "open_answer",
      "description": "What colour is a lemon?",
      "correct_answer": "Yellow",
      "explanation": "Lemons ripen from green to yellow."
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/quiz/embed?p=-Nq8sample_activity_key",
  "message": "Quiz created successfully"
}
Otvoriť editor Späť nahor

Stolová hra

api_e_board_game

#
POST /api/public/v1/board-game 1 až 100 v items
Obsah

api_c_board_game

Náhradný názov je “Board Game API”

Dobré vedieť
  • question_type je buď "multiple_choice", kde má správna možnosť isCorrect true, "true_false", teda to isté s presne dvoma možnosťami, najprv true a potom false, alebo "open_answer", ktorý namiesto toho používa correct_answer. Ak chýba, berie sa ako otázka s výberom.
Nastavenia, ktoré číta
PoleTypČo robí
number_of_tiles
voliteľné v settings
number
numberKoľko políčok má doska. Od 10 do 75.
Predvolené: 30
game_mode
voliteľné v settings
string
stringČi hráči pretekajú do cieľa, alebo cestou zbierajú predmety.
Jedno z race_to_finishcollect_items
Predvolené: "race_to_finish"
Ukážková požiadavka
POST board-game 
curl -X POST https://puzzel.org/api/public/v1/board-game \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Board Game",
  "language": "sk",
  "items": [
    {
      "question_type": "multiple_choice",
      "description": "Which fruit is yellow?",
      "answers": [
        {
          "type": "text",
          "description": "Banana",
          "isCorrect": true
        },
        {
          "type": "text",
          "description": "Cherry",
          "isCorrect": false
        }
      ]
    },
    {
      "question_type": "open_answer",
      "description": "What colour is a lemon?",
      "correct_answer": "Yellow",
      "explanation": "Lemons ripen from green to yellow."
    }
  ],
  "settings": {
    "number_of_tiles": 30,
    "game_mode": "race_to_finish"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/board-game/embed?p=-Nq8sample_activity_key",
  "message": "Board Game created successfully"
}
Otvoriť editor Späť nahor

Bludisko

Bludisko na prejdenie: každá otázka je sieň a jej odpovede sú dvere.

#
POST /api/public/v1/maze Aspoň 1 v items
Obsah

Pole otázok s výberom alebo otázok pravda/nepravda, presne v tvare, aký berie koncový bod kvízu. Otvorené otázky sa odmietnu: na dvere treba napísať odpoveď.

Náhradný názov je “Maze API”

Nastavenia, ktoré číta
PoleTypČo robí
maze_width
voliteľné v settings
string
stringAko sú siene rozložené: jeden stĺpec, štvorec alebo širšie.
Jedno z narrownormalwide
Predvolené: "normal"
maze_corridors
voliteľné v settings
string
stringKoľko bludiska leží medzi dvoma otázkami.
Jedno z shortnormallong
Predvolené: "normal"
maze_fog
voliteľné v settings
string
stringZobraziť celé bludisko, alebo len to, popri čom hráč už prešiel.
Jedno z offnear
Predvolené: "off"
maze_wrong_door_pause
voliteľné v settings
string
stringAko dlho ostanú dvere zatvorené po nesprávnych dverách.
Jedno z noneshortlong
Predvolené: "short"
maze_walk_there
voliteľné v settings
boolean
booleanPonúkne tlačidlo, ktoré prevedie figúrku do ďalšej siene.
Predvolené: false
maze_seed
voliteľné v settings
string
stringZáklad, z ktorého sa bludisko vygeneruje. Rovnaký základ a otázky dajú rovnaké bludisko; ak ho vynecháš, vyžrebuje sa nové.
Ukážková požiadavka
POST maze 
curl -X POST https://puzzel.org/api/public/v1/maze \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Maze",
  "language": "sk",
  "items": [
    {
      "question_type": "multiple_choice",
      "description": "What is it called when water vapour turns back into liquid droplets?",
      "answers": [
        {
          "type": "text",
          "description": "Evaporation",
          "isCorrect": false
        },
        {
          "type": "text",
          "description": "Condensation",
          "isCorrect": true
        },
        {
          "type": "text",
          "description": "Transpiration",
          "isCorrect": false
        }
      ],
      "explanation": "Cooling vapour condenses into the droplets that make clouds."
    },
    {
      "question_type": "true_false",
      "description": "Most of the water on Earth is fresh water.",
      "answers": [
        {
          "type": "text",
          "description": "True",
          "isCorrect": false
        },
        {
          "type": "text",
          "description": "False",
          "isCorrect": true
        }
      ]
    }
  ],
  "settings": {
    "maze_width": "wide",
    "maze_corridors": "short",
    "maze_seed": "water123",
    "maze_fog": "near"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/maze/embed?p=-Nq8sample_activity_key",
  "message": "Maze created successfully"
}
Otvoriť editor Späť nahor

Jeopardy

Tabuľa ako v televíznej súťaži: kategórie navrchu a pod nimi indície, ktoré majú väčšiu hodnotu, čím nižšie sú.

#
POST /api/public/v1/jeopardy Aspoň 2 v items
Obsah

Pole kategórií, zľava doprava. Každá má názov a svoje indície od horného riadka nadol.

Náhradný názov je “Jeopardy API”

Dobré vedieť
  • Indícia je otázka v tvare, aký berie koncový bod kvízu, open_answer, ak nie je uvedené inak, s poľom correct_answer a voliteľne aliases. Môže niesť aj value (vlastnú hodnotu) a daily_double. null nechá políčko prázdne.
Nastavenia, ktoré číta
PoleTypČo robí
jeopardy_buzzer_mode
voliteľné v settings
string
stringKto hrá ako: moderátor ju vedie z konzoly, hráči sa hlásia z telefónov, alebo každý hráč hrá tabuľu sám.
Jedno z hostphonessolo
Predvolené: "host"
jeopardy_contestants
voliteľné v settings
string
stringČi konzola hovorí o tímoch, alebo o hráčoch.
Jedno z teamsplayers
Predvolené: "teams"
jeopardy_value_step
voliteľné v settings
number
numberHodnota riadka: indícia má túto hodnotu krát číslo svojho riadka. Od 50 do 500, po 50.
Predvolené: 100
jeopardy_answer_time
voliteľné v settings
number
numberSekundy na odpoveď po otvorení indície, najviac 300. 0 znamená bez časovača.
Predvolené: 20
jeopardy_wrong_answer_costs
voliteľné v settings
boolean
booleanNesprávna odpoveď odoberie zo skóre hodnotu indície.
Predvolené: false
jeopardy_reveal_on_timeout
voliteľné v settings
boolean
booleanTabuľa sama ukáže odpoveď, keď vyprší čas.
Predvolené: false
jeopardy_require_question_form
voliteľné v settings
boolean
booleanPripomenie hráčom, aby odpovedali vo forme otázky.
Predvolené: false
Ukážková požiadavka
POST jeopardy 
curl -X POST https://puzzel.org/api/public/v1/jeopardy \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Jeopardy",
  "language": "sk",
  "items": [
    {
      "name": "Planets",
      "questions": [
        {
          "question_type": "open_answer",
          "description": "The planet closest to the Sun.",
          "correct_answer": "Mercury"
        },
        {
          "question_type": "open_answer",
          "description": "It is known as the red planet.",
          "correct_answer": "Mars",
          "explanation": "Iron oxide in its soil gives it the colour."
        },
        {
          "question_type": "multiple_choice",
          "description": "This planet has the most confirmed moons.",
          "answers": [
            {
              "description": "Jupiter",
              "isCorrect": false
            },
            {
              "description": "Saturn",
              "isCorrect": true
            },
            {
              "description": "Neptune",
              "isCorrect": false
            }
          ],
          "daily_double": true
        }
      ]
    },
    {
      "name": "Moons",
      "questions": [
        {
          "question_type": "open_answer",
          "description": "The only world besides Earth that people have walked on.",
          "correct_answer": "The Moon",
          "aliases": [
            "Luna"
          ]
        },
        null,
        {
          "question_type": "name_them_all",
          "description": "Name the four Galilean satellites.",
          "answers": [
            {
              "description": "Io"
            },
            {
              "description": "Europa"
            },
            {
              "description": "Ganymede",
              "aliases": [
                "Ganymedes"
              ]
            },
            {
              "description": "Callisto"
            }
          ],
          "required_count": 3,
          "value": 500
        }
      ]
    }
  ],
  "settings": {
    "jeopardy_buzzer_mode": "solo",
    "jeopardy_value_step": 200,
    "jeopardy_wrong_answer_costs": true
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/jeopardy/embed?p=-Nq8sample_activity_key",
  "message": "Jeopardy board created successfully"
}
Otvoriť editor Späť nahor

Interaktívne video

api_e_interactive_video

#
POST /api/public/v1/interactive-video 1 až 50 v items
Obsah

api_c_interactive_video

Náhradný názov je “Interactive Video API”

Dobré vedieť
  • Vyskakovacie okno je objekt s poľami time (sekundy, alebo "1:23"), kind ("question", ak nie je uvedené "note", "think" alebo "chapter") a description. Otázka je otázka v tvare, aký berie koncový bod kvízu, a môže niesť rewind_to: odkiaľ sa po nesprávnej odpovedi video prehrá znova.
Nastavenia, ktoré číta
PoleTypČo robí
video_url
povinné v settings
string
stringVideo: stránka na YouTube, Vimeo alebo Bunny Stream, alebo priamy odkaz na súbor mp4, webm alebo mov.
video_duration
voliteľné v settings
number
numberDĺžka videa v sekundách. Ak ju uvedieš, vyskakovacie okno za koncom sa odmietne.
Ukážková požiadavka
POST interactive-video 
curl -X POST https://puzzel.org/api/public/v1/interactive-video \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Interactive Video",
  "language": "sk",
  "items": [
    {
      "time": 5,
      "kind": "chapter",
      "description": "Evaporation"
    },
    {
      "time": 42.5,
      "kind": "question",
      "question_type": "multiple_choice",
      "description": "What turns liquid water into vapour?",
      "answers": [
        {
          "type": "text",
          "description": "Heat from the sun",
          "isCorrect": true
        },
        {
          "type": "text",
          "description": "Wind from the north",
          "isCorrect": false
        },
        {
          "type": "text",
          "description": "Salt in the sea",
          "isCorrect": false
        }
      ],
      "explanation": "The sun warms the surface and the water evaporates.",
      "rewind_to": 20
    }
  ],
  "settings": {
    "video_url": "https://www.youtube.com/watch?v=al-do-HGuIk",
    "video_duration": 180,
    "video_allow_skipping": true
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/interactive-video/embed?p=-Nq8sample_activity_key",
  "message": "Interactive video created successfully"
}
Otvoriť editor Späť nahor
Vety a čísla

Kryptogram

Zmení vetu na kód na rozlúštenie, znak po znaku.

#
POST /api/public/v1/cryptogram Neberie žiadne items
Obsah

Jedna veta v poli sentence. Tento koncový bod neberie žiadne items.

Náhradný názov je “Cryptogram API”

Dobré vedieť
  • Čokoľvek pošleš v items, sa ignoruje — hlavolam sa zostaví len z vety.
Nastavenia, ktoré číta
PoleTypČo robí
sentence
povinné
string
stringVeta, ktorá sa zašifruje. Hráči ju dekódujú znak po znaku.
helpers
voliteľné v settings
string
stringKtoré znaky sa prezradia zadarmo ako pomoc na začiatok: žiadne, najčastejšie, samohlásky alebo tie, ktoré uvedieš.
Jedno z nonemost_commonvowelscustom
Predvolené: "none"
character_list
voliteľné v settings
string
stringAbeceda, z ktorej sa šifra zostaví. Ak zostane prázdna, šifrovanie si zvolí vlastnú.
extra_letters
voliteľné v settings
string
stringZnaky, ktoré sa prezradia, keď je helpers "custom". Pri ostatných režimoch pomoci sa ignoruje.
hide_unused_characters
voliteľné v settings
boolean
booleanVynechá z kľúča šifry znaky, ktoré sa vo vete nikdy nevyskytujú.
Predvolené: false
Ukážková požiadavka
POST cryptogram 
curl -X POST https://puzzel.org/api/public/v1/cryptogram \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Cryptogram",
  "language": "sk",
  "sentence": "An apple a day keeps the doctor away",
  "settings": {
    "helpers": "vowels",
    "hide_unused_characters": false
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/cryptogram/embed?p=-Nq8sample_activity_key",
  "message": "Cryptogram created successfully"
}
Otvoriť editor Späť nahor

Počtové cvičenie

Skryje vetu za príklady — vyrieš príklad, odkryješ písmeno.

#
POST /api/public/v1/calculation Neberie žiadne items
Obsah

Jedna veta v poli sentence. Tento koncový bod neberie žiadne items.

Náhradný názov je “Calculation Game API”

Dobré vedieť
  • Ak sú obmedzenia príliš tesné na zakódovanie vety, volanie odpovie kódom 400 s výzvou uvoľniť ich, namiesto toho aby uložilo neúplný hlavolam.
Nastavenia, ktoré číta
PoleTypČo robí
sentence
povinné
string
stringVeta, ktorú hráči odkrývajú riešením príkladov.
difficulty_level
voliteľné v settings
number
numberNajvyšší výsledok, ktorý smie príklad mať.
Jedno z 20501001000
Predvolené: "100"
operators
voliteľné v settings
string[]
string[]Ktoré operácie sa môžu objaviť. x je násobenie, : je delenie.
Jedno z +-x:
Predvolené: ["+", "-", "x", ":"]
max_operations
voliteľné v settings
number
numberKoľko operácií môže jeden príklad reťaziť.
Jedno z 123
Predvolené: 1
number_difficulty
voliteľné v settings
number
numberObmedzuje jednotlivé čísla v príklade. Kdekoľvek od 5 do 1000.
Predvolené: 100
Ukážková požiadavka
POST calculation 
curl -X POST https://puzzel.org/api/public/v1/calculation \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Calculation Game",
  "language": "sk",
  "sentence": "Fruit salad for everyone",
  "settings": {
    "difficulty_level": "100",
    "operators": [
      "+",
      "-",
      "x",
      ":"
    ],
    "max_operations": 1,
    "number_difficulty": 100
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/calculation/embed?p=-Nq8sample_activity_key",
  "message": "Calculation game created successfully"
}
Otvoriť editor Späť nahor

Sudoku

Vygeneruje vyriešenú mriežku a potom z nej vyberie čísla.

#
POST /api/public/v1/sudoku Neberie žiadne items
Obsah

Nič. Celý hlavolam vznikne z jeho dvoch nastavení.

Náhradný názov je “Sudoku API”

Dobré vedieť
  • Neposielaj items ani sentence — veľkosť a obťažnosť sú celý vstup.
  • Editor ponúka obťažnosť len pre 2x3, 3x3 a 3x4. API ju uplatní na každú veľkosť, vrátane 2x2 a 4x4.
Nastavenia, ktoré číta
PoleTypČo robí
size
voliteľné v settings
string
stringVeľkosť jedného bloku zapísaná ako riadky krát stĺpce — 3x3 dáva klasickú mriežku 9x9. Koncový bod overuje len to, že sa to dá načítať ako dve čísla, tak zostaň pri veľkostiach, ktoré ponúka editor.
Jedno z 2x22x33x33x44x4
Predvolené: "3x3"
difficulty_level
voliteľné v settings
string
stringKoľko čísel zostane v mriežke na začiatok.
Jedno z easynormalhard
Predvolené: "normal"
Ukážková požiadavka
POST sudoku 
curl -X POST https://puzzel.org/api/public/v1/sudoku \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Sudoku",
  "language": "sk",
  "settings": {
    "size": "3x3",
    "difficulty_level": "normal"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/sudoku/embed?p=-Nq8sample_activity_key",
  "message": "Sudoku created successfully"
}
Otvoriť editor Späť nahor

Padnutá veta

api_e_fallen_phrase

#
POST /api/public/v1/fallen-phrase Neberie žiadne items
Obsah

api_c_fallen_phrase

Náhradný názov je “Fallen Phrase API”

Nastavenia, ktoré číta
PoleTypČo robí
sentence
povinné
string
stringVeta, ktorá sa ukryje: citát, príslovie, kľúčová veta. Najviac 120 písmen a číslic.
columns
voliteľné v settings
number
numberAká široká je mriežka, od 8 do 18. Užšia nakopí do každého stĺpca viac písmen a je ťažšia.
Predvolené: 14
helpers
voliteľné v settings
string
stringKtoré písmená ostanú v mriežke ako pomoc na začiatok: žiadne, najčastejšie, samohlásky alebo tie, ktoré uvedieš.
Jedno z nonemost_commonvowelscustom
Predvolené: "none"
extra_letters
voliteľné v settings
string
stringPísmená, ktoré sa prezradia, keď je helpers "custom".
Ukážková požiadavka
POST fallen-phrase 
curl -X POST https://puzzel.org/api/public/v1/fallen-phrase \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Fallen Phrase",
  "language": "sk",
  "sentence": "Don't count your chickens before they hatch.",
  "settings": {
    "columns": 12,
    "helpers": "custom",
    "extra_letters": "ky"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/fallen-phrase/embed?p=-Nq8sample_activity_key",
  "message": "Fallen phrase created successfully"
}
Otvoriť editor Späť nahor

Násobilka

api_e_times_tables

#
POST /api/public/v1/times-tables Neberie žiadne items
Obsah

api_c_times_tables

Náhradný názov je “Times Tables API”

Nastavenia, ktoré číta
PoleTypČo robí
tables
voliteľné v settings
number[]
number[]Tabuľky na precvičovanie. Ak ich vynecháš, je to 1 až 10; pri 11 alebo 12 má mriežka rozmer 12 krát 12.
Jedno z 123456789101112
order
voliteľné v settings
string
stringČi riadky a stĺpce idú po poradí, alebo sú pomiešané.
Jedno z ascendingshuffled
Predvolené: "ascending"
picture
voliteľné v settings
string
stringObrázok, ktorý správne odpovede vyfarbujú.
Jedno z sailboatheartrockettreecatfishflowerhouse
Predvolené: "sailboat"
players_choose_tables
voliteľné v settings
boolean
booleanNechá každého hráča vybrať, ktoré z tabuliek chce precvičovať.
Predvolené: false
fill_same_sums
voliteľné v settings
boolean
booleanJedna správna odpoveď vyplní všetky políčka s rovnakým príkladom.
Predvolené: true
Ukážková požiadavka
POST times-tables 
curl -X POST https://puzzel.org/api/public/v1/times-tables \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Times Tables",
  "language": "sk",
  "settings": {
    "tables": [
      7,
      3,
      4
    ],
    "order": "shuffled",
    "seed": "k3x9q2ab",
    "picture": "rocket",
    "players_choose_tables": true,
    "fill_same_sums": false
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/times-tables/embed?p=-Nq8sample_activity_key",
  "message": "Times tables created successfully"
}
Otvoriť editor Späť nahor

Doplňovačka

api_e_fill_in_the_gap

#
POST /api/public/v1/fill-in-the-gap 1 až 50 v items
Obsah

api_c_fill_in_the_gap

Náhradný názov je “Fill in the gap API”

Dobré vedieť
  • Napíš celú vetu a okolo každého slova, ktoré sa má vynechať, daj hviezdičky: "Water boils at *100* degrees." Viac slov v jednej dvojici hviezdičiek je jedna medzera. Položka môže niesť aj pokyn zobrazený nad vetou.
Ukážková požiadavka
POST fill-in-the-gap 
curl -X POST https://puzzel.org/api/public/v1/fill-in-the-gap \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Fill in the gap",
  "language": "sk",
  "items": [
    {
      "sentence": "The capital of France is *Paris*, and the river that runs through it is the *Seine*."
    },
    {
      "sentence": "*Amsterdam* is the capital of the Netherlands, but the government sits in *The Hague*.",
      "instruction": "Two cities, one of them two words."
    },
    {
      "sentence": "The *Danube* flows through Vienna, Bratislava, *Budapest* and Belgrade."
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/fill-in-the-gap/embed?p=-Nq8sample_activity_key",
  "message": "Fill in the gap created successfully"
}
Otvoriť editor Späť nahor

Vetný rozbor

Vety, v ktorých hráči označujú slová: slovné druhy, vetné členy alebo vlastné označenia.

#
POST /api/public/v1/deconstruct 1 až 50 v items
Obsah

Pole viet. Každé slovo, ktoré sa má označiť, sa zapíše ako [word](label).

Náhradný názov je “Sentence analysis API”

Dobré vedieť
  • Vetu zapíš ako "The [dog](noun) [barks](verb)." Slová bez značky sa zobrazia, ale nikto sa na ne nepýta. Označenia noun, verb, adjective a subject sa každému hráčovi zobrazia v jeho jazyku.
Nastavenia, ktoré číta
PoleTypČo robí
categories
voliteľné v settings
string[]
string[]Označenia, z ktorých hráči vyberajú, v poradí. Ak ich vynecháš, použijú sa označenia z viet. Pošli ich, ak chceš pridať označenie, ktoré nemá žiadne slovo, alebo upraviť poradie.
Ukážková požiadavka
POST deconstruct 
curl -X POST https://puzzel.org/api/public/v1/deconstruct \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Sentence analysis",
  "language": "sk",
  "items": [
    {
      "sentence": "The [old](adjective) [farmer](noun) [feeds](verb) the [hungry](adjective) [chickens](noun) [early](adverb).",
      "instruction": "Label the nouns, verbs, adjectives and adverbs."
    },
    {
      "sentence": "A [brown](adjective) [horse](noun) [jumped](verb) [quickly](adverb) over the [fence](noun)."
    },
    {
      "sentence": "[Two small lambs](subject) [sleep](verb) in the [barn](noun), and the [dog](noun) [watches](verb) [quietly](adverb)."
    }
  ],
  "settings": {
    "categories": [
      "noun",
      "verb",
      "adjective",
      "adverb",
      {
        "name": "subject",
        "color": "#224466"
      },
      "preposition"
    ]
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/deconstruct/embed?p=-Nq8sample_activity_key",
  "message": "Sentence analysis created successfully"
}
Otvoriť editor Späť nahor

Logická úloha

api_e_logic_puzzle

#
POST /api/public/v1/logic-puzzle Aspoň 3 v items
Obsah

api_c_logic_puzzle

Náhradný názov je “Logic Puzzle API”

Dobré vedieť
  • Každá kategória potrebuje rovnaký počet položiek, 3 až 6, všetky rôzne. Jedna kategória môže byť označená ako usporiadaná (ceny, časy, vek) s voliteľnou jednotkou, vďaka čomu generátor vie písať indície o viac, menej a o koľko.
Nastavenia, ktoré číta
PoleTypČo robí
story
voliteľné v settings
string
stringPríbeh na pozadí zobrazený nad indíciami.
difficulty
voliteľné v settings
string
stringAké druhy indícií smie generátor použiť.
Jedno z easymediumhard
Predvolené: "easy"
hints
voliteľné v settings
boolean
booleanPonúkne tlačidlo, ktoré ukáže ďalší krok.
Predvolené: true
auto_cross
voliteľné v settings
boolean
booleanOznačenie zhody preškrtne zvyšok jej riadka a stĺpca.
Predvolené: true
clue_mode
voliteľné v settings
string
stringKto píše indície, ktoré hráči vidia: generované z tabuľky, tvoje vlastné vety v free_clues, alebo žiadne.
Jedno z generatedfreenone
Predvolené: "generated"
free_clues
voliteľné v settings
string[]
string[]Tvoje vlastné vety s indíciami, zobrazené tak, ako sú napísané, s clue_mode "free". Nič ich nekontroluje.
Ukážková požiadavka
POST logic-puzzle 
curl -X POST https://puzzel.org/api/public/v1/logic-puzzle \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Logic Puzzle",
  "language": "sk",
  "items": [
    {
      "name": "Baker",
      "items": [
        "Amira",
        "Jonas",
        "Priya",
        "Tobias"
      ]
    },
    {
      "name": "Cake",
      "items": [
        "Lemon drizzle",
        "Carrot cake",
        "Brownies",
        "Apple pie"
      ]
    },
    {
      "name": "Price",
      "items": [
        "$2",
        "$4",
        "$6",
        "$8"
      ],
      "ordered": true,
      "unit": "dollars"
    }
  ],
  "settings": {
    "story": "Four friends each baked one thing for the school bake sale and each set a different price. Who baked what, and what did it cost?",
    "difficulty": "medium"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/logic-puzzle/embed?p=-Nq8sample_activity_key",
  "message": "Logic puzzle created successfully"
}
Otvoriť editor Späť nahor

Hľadanie pokladu

api_e_scavenger_hunt

#
POST /api/public/v1/scavenger-hunt 1 až 50 v items
Obsah

api_c_scavenger_hunt

Náhradný názov je “Scavenger Hunt API”

Dobré vedieť
  • Krok je objekt s poľami title, description, code a voliteľne accepted_codes (iné pravopisy, ktoré sa uznajú), url a link_text. Kód sa kontroluje bez ohľadu na veľké písmená a medzery. Mapu s ihlicami možno pridať len v editore.
Ukážková požiadavka
POST scavenger-hunt 
curl -X POST https://puzzel.org/api/public/v1/scavenger-hunt \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Scavenger Hunt",
  "language": "sk",
  "items": [
    {
      "title": "Start at the front desk",
      "description": "Which year is carved above the entrance?",
      "code": "1897",
      "accepted_codes": [
        "eighteen ninety-seven"
      ]
    },
    {
      "title": "The quiet corner",
      "description": "Find the atlas shelf. What colour is the biggest atlas?",
      "code": "crimson",
      "accepted_codes": [
        "dark red"
      ]
    }
  ]
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/scavenger-hunt/embed?p=-Nq8sample_activity_key",
  "message": "Scavenger hunt created successfully"
}
Otvoriť editor Späť nahor

Priestorová predstavivosť

api_e_spatial_reasoning

#
POST /api/public/v1/spatial-reasoning 1 až 50 v items
Obsah

api_c_spatial_reasoning

Náhradný názov je “Spatial Reasoning API”

Dobré vedieť
  • Objekty a ciele sú square, triangle, circle, hexagon, pentagon, star, diamond alebo heart. Vzťahy sú inside, outside, behind, in_front_of, right_of, left_of, above, below, same_color_as, different_color_from, larger_than a smaller_than. Pravidlo, ktoré sa nikdy nedá splniť, odpovie kódom 400.
Nastavenia, ktoré číta
PoleTypČo robí
clue_mode
voliteľné v settings
string
stringPravidlá zobrazené ako obrázky alebo ako vety.
Jedno z visualtext
Predvolené: "visual"
unique_object_picks
voliteľné v settings
boolean
booleanKaždý tvar sa smie umiestniť len raz.
Predvolené: false
hide_color_picker
voliteľné v settings
boolean
booleanHráči nemôžu tvary prefarbovať.
Predvolené: false
Ukážková požiadavka
POST spatial-reasoning 
curl -X POST https://puzzel.org/api/public/v1/spatial-reasoning \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Spatial Reasoning",
  "language": "sk",
  "items": [
    {
      "rules": [
        {
          "object": "square",
          "relation": "inside",
          "target": "circle"
        }
      ]
    },
    {
      "rules": [
        {
          "object": "triangle",
          "relation": "above",
          "target": "square"
        },
        {
          "object": "star",
          "relation": "left_of",
          "target": "triangle"
        }
      ]
    }
  ],
  "settings": {
    "clue_mode": "text",
    "unique_object_picks": true,
    "hide_color_picker": false
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/spatial-reasoning/embed?p=-Nq8sample_activity_key",
  "message": "Spatial reasoning activity created successfully"
}
Otvoriť editor Späť nahor

Rébus

Vety napísané obrázkami: hráči čítajú obrázky a zmeny písmen premieňajú späť na slová.

#
POST /api/public/v1/rebus 1 až 30 v items
Obsah

Pole viet. Každá uvádza slová nakreslené ako obrázky; každé iné slovo ostáva zapísané písmenami.

Náhradný názov je “Rebus API”

Dobré vedieť
  • Slovo sa skladá z častí, ktoré dokopy dávajú jeho písmená. Časť má písmená, ktoré zastupuje (text), emoji a shows: slovo pre to, čo obrázok ukazuje ("broom" pre obrázok, ktorý zastupuje "room"). Zmeny písmen si Puzzel vypočíta sám. Časť môže byť namiesto toho symbol, napríklad 4 pre "for".
Nastavenia, ktoré číta
PoleTypČo robí
rebus_commas
voliteľné v settings
boolean
booleanVynechané prvé alebo posledné písmeno zakreslí ako čiarku vedľa obrázka.
Predvolené: false
Ukážková požiadavka
POST rebus 
curl -X POST https://puzzel.org/api/public/v1/rebus \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Rebus",
  "language": "sk",
  "items": [
    {
      "sentence": "I sweep the room before the sunflower wilts.",
      "words": [
        {
          "word": "I",
          "parts": [
            {
              "text": "I",
              "kind": "sound",
              "emoji": "👁️"
            }
          ]
        },
        {
          "word": "room",
          "parts": [
            {
              "text": "room",
              "kind": "picture",
              "shows": "broom",
              "emoji": "🧹"
            }
          ]
        },
        {
          "word": "before",
          "parts": [
            {
              "text": "be",
              "kind": "picture",
              "shows": "bee",
              "emoji": "🐝"
            },
            {
              "text": "for",
              "kind": "sound",
              "glyph": "4"
            },
            {
              "text": "e",
              "kind": "letters"
            }
          ]
        },
        {
          "word": "the",
          "position": 6,
          "parts": [
            {
              "text": "the",
              "kind": "picture",
              "shows": "tree",
              "emoji": "🌳"
            }
          ]
        },
        {
          "word": "sunflower",
          "parts": [
            {
              "text": "sun",
              "kind": "picture",
              "shows": "sun",
              "emoji": "☀️"
            },
            {
              "text": "flower",
              "kind": "picture",
              "shows": "flower",
              "emoji": "🌸"
            }
          ]
        }
      ]
    }
  ],
  "settings": {
    "rebus_commas": true
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/rebus/embed?p=-Nq8sample_activity_key",
  "message": "Rebus created successfully"
}
Otvoriť editor Späť nahor
Obrázky

Puzzle

Rozstrihá obrázok na diely, ktoré sa ťahaním poskladajú späť.

#
POST /api/public/v1/jigsaw Neberie žiadne items
Obsah

Jedna URL obrázka v poli image. Tento koncový bod neberie žiadne items.

Náhradný názov je “Jigsaw Game API”

Dobré vedieť
  • API vždy vytvorí puzzle 4 krát 4. Počet dielov, nepravidelné diely a rovné okraje sú nastavenia editora — poslať sem rows alebo columns nemá žiadny účinok.
  • URL sa uloží presne tak, ako ju pošleš, a súbor sa nikdy nekopíruje, takže musí zostať verejne dostupná tak dlho, kým sa aktivita hrá.
Nastavenia, ktoré číta
PoleTypČo robí
image
povinné
string
stringAbsolútna URL obrázka, ktorý sa rozstrihá. Posiela sa na najvyššej úrovni, nie vnútri settings.
Ukážková požiadavka
POST jigsaw 
curl -X POST https://puzzel.org/api/public/v1/jigsaw \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Jigsaw Game",
  "language": "sk",
  "image": "https://example.com/orchard.jpg"
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/jigsaw/embed?p=-Nq8sample_activity_key",
  "message": "Jigsaw game created successfully"
}
Otvoriť editor Späť nahor

Posuvná skladačka

Pomieša obrázok na dlaždice, ktoré sa posúvajú na miesto.

#
POST /api/public/v1/slidingpuzzle Neberie žiadne items
Obsah

Jedna URL obrázka vnútri settings. Tento koncový bod neberie žiadne items.

Náhradný názov je “Sliding Puzzle API”

Dobré vedieť
  • Na rozdiel od puzzle číta tento koncový bod svoj obrázok zo settings.image. Pole image na najvyššej úrovni sa ignoruje a volanie odpovie kódom 400.
  • URL sa uloží presne tak, ako ju pošleš, a súbor sa nikdy nekopíruje, takže musí zostať verejne dostupná tak dlho, kým sa aktivita hrá.
Nastavenia, ktoré číta
PoleTypČo robí
image
povinné v settings
string
stringAbsolútna URL obrázka, ktorý sa pomieša. Na rozdiel od puzzle je táto vnútri settings.
Ukážková požiadavka
POST slidingpuzzle 
curl -X POST https://puzzel.org/api/public/v1/slidingpuzzle \
  -H "Content-Type: application/json" \
  -d '{
  "account_api_key": "YOUR_API_KEY",
  "email": "you@example.com",
  "title": "Sliding Puzzle",
  "language": "sk",
  "settings": {
    "image": "https://example.com/orchard.jpg"
  }
}'
Úspech 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/slidingpuzzle/embed?p=-Nq8sample_activity_key",
  "message": "Sliding puzzle created successfully"
}
Otvoriť editor Späť nahor

Niečo nefunguje, ako má?

Pošli svoju požiadavku aj chybu, ktorá prišla späť, a dostaneš skutočnú odpoveď od človeka, ktorý ten koncový bod napísal.

Napísať podpore