Ugrás a tartalomra
Fejlesztői API

Készíts tevékenységeket a saját rendszeredből

Tevékenységtípusonként egy POST. Küldd el a tartalmadat JSON-ként, és kapsz egy tevékenységet a Puzzel.org-fiókodban, meg egy URL-t, amelyet odaadhatsz a játékosoknak vagy beilleszthetsz egy iframe-be.

Alap-URL
https://puzzel.org/api/public/v1
Hitelesítés
Kulcs + e-mail a törzsben
Végpontok
38 tevékenységtípus
Kvóta
10 tevékenység naponta

Az első kérésed

Nincs mit telepíteni, és nincs kézfogás: küldj egy JSON törzset a kulcsoddal, az e-mail-címeddel és a tartalmaddal. A válasz tartalmazza az új tevékenység kulcsát és az URL-t, amelyen játszani lehet vele.

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": "hu",
  "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"
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}

Az oldal minden példája teljes, futtatható kérés. Cseréld be a saját kulcsodat és tartalmadat, és máris működik.

Hitelesítés

Nincsenek fejlécek, és nincs bearer token. Mindkét azonosító minden kérés JSON törzsében utazik, és a kulcs csak ahhoz a fiókhoz jó, amelyhez az e-mail-cím tartozik.

MezőTípusMit csinál
account_api_key
kötelező
string
stringA fiókod API-kulcsa. A törzsbe kerül, nem a fejlécbe.
email
kötelező
string
stringAz a cím, amellyel a Puzzel.org-fiókod bejelentkezik. A kulcs csak ezzel együtt érvényes.

A kulcsod az irányítópultod fiók szakaszában van, a Megjelenítés mögött.

Bejelentkezés

Az API-kulcs az előfizetés indulásával jár, így ingyenes fiókhoz még nem tartozik.

Csomagok megtekintése

Úgy kezeld a kulcsot, mint egy jelszót. Tevékenységeket hoz létre és ír felül a fiókodban, ezért tartsd a szerveren, és ne tedd olyan helyre, amit egy böngésző elolvashat.

A kérés törzse

Minden végpont ugyanazt az öt mezőt várja. A különbség az alattuk lévő tartalommezőben van: a legtöbb egy items tömböt kér, néhány egyetlen mondatot vagy képet, a Sudoku pedig semmit.

MezőTípusMit csinál
account_api_key
kötelező
string
stringA fiókod API-kulcsa. A törzsbe kerül, nem a fejlécbe.
email
kötelező
string
stringAz a cím, amellyel a Puzzel.org-fiókod bejelentkezik. A kulcs csak ezzel együtt érvényes.
title
opcionális
string
stringA név, amelyet a tevékenység az irányítópultodon kap. Ha kihagyod, a végpont a saját tartaléknevét használja.
language
opcionális
string
stringCsak azt dönti el, milyen nyelvi kód kerül a visszakapott URL-be — semmit nem fordít le abból, amit küldesz. A szókereső emellett arra is használja, hogy "ar" esetén arabra váltsa a kitöltő betűket.
Alapérték: "en"
activity_key
opcionális
string
stringHagyd ki, ha új tevékenységet szeretnél létrehozni. Ha egy már meglévő tevékenységed kulcsát adod meg, akkor helyette az a tevékenység épül újra.

A settings egy objektum, benne a végpontonként eltérő opciókkal. Hogy egy végpont melyeket olvassa, alább, az adott végpontnál látod; bármi mást teszel bele, azt figyelmen kívül hagyja.

Mit kapsz vissza

A sikeres hívás 200-zal válaszol, és megadja az új tevékenység kulcsát meg az URL-t, amelyen játszani lehet vele. Minden más esetben a success értéke false, és egyetlen error szöveg érkezik.

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

A visszakapott url a beágyazott nézet. Cseréld az embed részt play-re, hogy teljes oldalon nyíljon meg, vagy build-re, hogy a szerkesztőben — a p= utáni kulcs ugyanaz marad.

Létrehozás vs. frissítés

Ha elküldöd az activity_key mezőt, a mögötte lévő tevékenység a helyén épül újra: a tartalma kicserélődik, a neve és a verziójelzése frissül, a kulcs viszont ugyanaz marad — így a már megosztott linkek és beágyazások tovább működnek. Az eredmények, a mappa, ahová került, és minden olyan beállítás, amelyet a végpont maga nem ír, változatlan marad.

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"
    }
  ]
}
  • A title minden frissítéskor érvényesül, az alapértéke is — ha kihagyod, a tevékenység az adott végpont tartaléknevét kapja.
  • Azokat a beállításblokkokat, amelyeket a végpont maga ír, nulláról írja újra, így a frissítés ezeket is visszaállítja az általad küldött értékekre vagy a végpont alapértékeire.
  • Csak a saját fiókod tevékenységeit frissítheted. Ha valaki máséhoz tartozó kulcsot küldesz, 403 a válasz.
  • A frissítés ugyanannyiba kerül, mint a létrehozás: egy hívás a mai kvótából.

Hívási korlát

10
10 tevékenység fiókonként naponta

Minden sikeres hívás beleszámít, a létrehozás és a frissítés egyaránt. Ha túlléped, a következő kérésre 429 a válasz, amíg a számláló nem nullázódik.

A számlálót naponta egyszer egy ütemezett feladat nullázza, nem gördülő 24 órás ablakban.

Hibák

A hibák mindig JSON-ként érkeznek, ugyanazzal a két mezővel, sosem HTML-oldalként. Az error szöveget embernek írtuk — megnevezi, melyik mező vagy melyik korlát okozta a bajt.

StátuszMit jelent
400
Bad Request
A törzsben valami hiányzik, hibás formátumú vagy tartományon kívül esik. Az üzenet megnevezi a mezőt.
401
Unauthorized
Az e-mail-cím ismeretlen, vagy a kulcs nem ahhoz a fiókhoz tartozik.
403
Forbidden
Az elküldött activity_key egy másik fiókhoz tartozik.
429
Too Many Requests
A mai kvóta elfogyott. Naponta egyszer nullázódik.
500
Server Error
A generátor nem tudott rejtvényt készíteni abból, amit küldtél — általában túl kevés a szó, vagy nem illeszthetők össze.

Végpontok

Tevékenységtípusonként egy útvonal, mind POST, mind ugyanazon az alap-URL-en. Mindegyiknél megtalálod a szükséges tartalmat, az általa olvasott beállításokat és egy futtatható kérést.

Szavak és betűk

Keresztrejtvény

Rácsba fűzi össze a válaszaidat, és megszámozza helyetted a meghatározásokat.

#
POST /api/public/v1/crossword 2–80 elem az items tömbben
Tartalom

Szavak tömbje. Minden elem egy választ és a rá mutató meghatározást párosítja.

Tartaléknév: “Crossword API”

Jó tudni
  • A két karakternél rövidebb válaszok kimaradnak, mielőtt a rács felépülne, és legalább kettőnek túl kell élnie ezt.
  • A válaszok nagybetűsek lesznek, és a generátor húsz próbálkozást kap az elhelyezésükre. Ha egyetlen szót sem tud elhelyezni, a hívás 500-zal válaszol.
Beolvasott beállítások
MezőTípusMit csinál
hidden_solution
opcionális a settings objektumban
string
stringOpcionális bónuszszó. A betűit a kész rács celláiban jelöljük, hogy a játékosok összegyűjthessék őket, miután megfejtették a keresztrejtvényt, ezért minden betűjének szerepelnie kell a válaszokban.
Példakérés
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": "hu",
  "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"
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/crossword/embed?p=-Nq8sample_activity_key",
  "message": "Crossword created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Szókereső

Elrejti a szavaidat egy betűrácsban, az általad választott irányokban és formában.

#
POST /api/public/v1/wordseeker 2–40 elem az items tömbben
Tartalom

Szavak tömbje. A meghatározás szövegéből lesz a szólista, amelyből a játékosok dolgoznak.

Tartaléknév: “Wordseeker API”

Jó tudni
  • A két karakternél rövidebb válaszok kimaradnak, és minden válasz nagybetűs lesz, mielőtt a rácsba kerül.
  • A rácsot latin betűk töltik ki, kivéve ha a language értéke "ar" — akkor a kitöltés arabra vált.
Beolvasott beállítások
MezőTípusMit csinál
hidden_solution
opcionális a settings objektumban
string
stringA megmaradt betűk ezt adják ki. Ha megadod, a generátor előbb a megoldást helyezi el, ahelyett hogy minél több szót zsúfolna be.
directions
opcionális a settings objektumban
string[]
string[]Milyen irányban futhat egy szó. Ha kihagyod, a szavak csak keletre, délkeletre és délre futnak.
Lehetséges értékek westeastnorthsouthnorthwestnortheastsouthwestsoutheast
Alapérték: ["east", "southeast", "south"]
template
opcionális a settings objektumban
string
stringFormára vágja a rácsot ahelyett, hogy négyzet maradna.
Lehetséges értékek squarecirclecrossdiamondpyramidsmileystarcross_plus
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/wordseeker/embed?p=-Nq8sample_activity_key",
  "message": "Wordseeker created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Akrosztichon

Úgy rendezi egymás alá a válaszaidat, hogy az egyik oszlop egy rejtett szót adjon ki.

#
POST /api/public/v1/acrostic 1–40 elem az items tömbben
Tartalom

Szavak tömbje. Együtt ki kell adniuk a rejtett szó minden betűjét.

Tartaléknév: “Acrostic API”

Jó tudni
  • Ha a válaszok nem adják ki a megoldáshoz szükséges betűket, a hívás 500-zal válaszol, ahelyett hogy félkész rácsot mentene.
  • A generátor átrendezi a válaszaidat, hogy az oszlop kijöjjön, így nem abban a sorrendben látják őket a játékosok, ahogy elküldted.
Beolvasott beállítások
MezőTípusMit csinál
hidden_solution
kötelező a settings objektumban
string
stringA szó, amelyet a kiemelt oszlop kiad. Enélkül ez a végpont nem fut le.
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/acrostic/embed?p=-Nq8sample_activity_key",
  "message": "Acrostic created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Betűkeverő

api_e_word_scramble

#
POST /api/public/v1/word-scramble 1–40 elem az items tömbben
Tartalom

api_c_word_scramble

Tartaléknév: “Word Scramble API”

Jó tudni
  • Az API-n keresztül készült tevékenységeknél a sorrend keverése mindig be van kapcsolva, így nem abban a sorrendben kapják a játékosok, ahogy elküldted.
Beolvasott beállítások
MezőTípusMit csinál
hidden_solution
opcionális a settings objektumban
string
stringOpcionális bónuszszó, amelyet a játékosok a többi megoldása után írnak be.
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/word-scramble/embed?p=-Nq8sample_activity_key",
  "message": "Word Scramble created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Akasztófa

Betűkitalálós körökké alakítja a szavaidat vagy kifejezéseidet.

#
POST /api/public/v1/hangman 1–50 elem az items tömbben
Tartalom

Szavak vagy rövid kifejezések tömbje. A nyom az a tipp, amelyet a játékosok látnak.

Tartaléknév: “Hangman API”

Példakérés
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": "hu",
  "items": [
    {
      "answer": "BANANA",
      "description": "A long yellow fruit",
      "type": "text"
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/hangman/embed?p=-Nq8sample_activity_key",
  "message": "Hangman created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Wordle

Minden elküldött szóból szókitalálós játékot csinál.

#
POST /api/public/v1/wordle 1–50 elem az items tömbben
Tartalom

Szavak tömbje. A játékosok szavanként egy kört kapnak.

Tartaléknév: “Wordle API”

Jó tudni
  • A “tippek valódi szavak-e” ellenőrzés bekapcsolva készül. Kapcsold ki a szerkesztőben, ha a szavaid nevek vagy kitaláltak.
Példakérés
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": "hu",
  "items": [
    {
      "answer": "MELON",
      "description": "Sweet and green",
      "type": "text"
    },
    {
      "answer": "PEACH",
      "description": "Fuzzy and orange",
      "type": "text"
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/wordle/embed?p=-Nq8sample_activity_key",
  "message": "Wordle created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Gépelésgyakorlás

api_e_typing_practice

#
POST /api/public/v1/typing-practice 1–50 elem az items tömbben
Tartalom

api_c_typing_practice

Tartaléknév: “Typing Practice API”

Példakérés
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": "hu",
  "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"
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/typing-practice/embed?p=-Nq8sample_activity_key",
  "message": "Typing Practice created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Szerencsekerék

api_e_wheel_of_fortune

#
POST /api/public/v1/wheel-of-fortune 1–50 elem az items tömbben
Tartalom

api_c_wheel_of_fortune

Tartaléknév: “Wheel of Fortune API”

Jó tudni
  • Az “eredmény csak a kerékben jelenjen meg” beállítással készül, így az eredményt a kerékről lehet leolvasni, nem mellette jelenik meg.
Példakérés
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": "hu",
  "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"
    }
  ]
}'
Siker 
{
  "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"
}
Szerkesztő megnyitása Vissza a tetejére

Svédrejtvény

Svédrejtvény: a meghatározások a rácsban ülnek, mindegyikhez egy nyíl mutat a válaszára.

#
POST /api/public/v1/arrowword 2–80 elem az items tömbben
Tartalom

Szavak tömbje. Minden elem egy választ és egy olyan meghatározást párosít, amely elég rövid ahhoz, hogy elférjen egy cellában.

Tartaléknév: “Arrowword API”

Beolvasott beállítások
MezőTípusMit csinál
hidden_solution
opcionális a settings objektumban
string
stringOpcionális bónuszszó. A betűit a kész rács celláiban jelöljük, ezért minden betűjének szerepelnie kell a válaszokban.
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/arrowword/embed?p=-Nq8sample_activity_key",
  "message": "Arrowword created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Strands

Olyan rács, amelyben minden betű egy témához tartozó szóhoz kapcsolódik, és egy, a témát megnevező szó az egyik szélétől a másikig fut.

#
POST /api/public/v1/strands 2–24 elem az items tömbben
Tartalom

Témaszavak tömbje. A spangrammal együtt a betűiknek pontosan ki kell tölteniük a táblát.

Tartaléknév: “Strands API”

Jó tudni
  • Az összes szó és a spangram betűinek száma együtt pontosan 30, 35, 36, 40, 42, 45, 48, 49, 50, 54, 56, 60, 63, 64, 70, 72 vagy 80 kell legyen. Bármilyen más szám 400-as hibát ad, és megmondja, hány betűt kell hozzáadni vagy elvenni.
Beolvasott beállítások
MezőTípusMit csinál
theme
opcionális a settings objektumban
string
stringA rács fölött megjelenő talány. Ha kihagyod, a játékosok a címet látják.
spangram
opcionális a settings objektumban
string
stringA szó vagy kifejezés, amely megnevezi a témát, és a tábla egyik szélétől a másikig átível.
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/strands/embed?p=-Nq8sample_activity_key",
  "message": "Strands created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

A felsorolás

api_e_name_them_all

#
POST /api/public/v1/name-them-all 1–250 elem az items tömbben
Tartalom

api_c_name_them_all

Tartaléknév: “Name Them All API”

Jó tudni
  • Az elem olyan objektum, amelynek van answer mezője, és opcionálisan aliases (más elfogadott írásmódok), description (a tipp) és group mezője. A név ellenőrzésekor a nagybetűk, az ékezetek és az írásjelek nem számítanak.
Beolvasott beállítások
MezőTípusMit csinál
list_match_mode
opcionális a settings objektumban
string
stringEgy név abban a pillanatban számít-e, amikor beírják, vagy csak az Enter megnyomásakor.
Lehetséges értékek while_typingon_enter
Alapérték: "while_typing"
list_slot_hint
opcionális a settings objektumban
string
stringMit árul el egy üres hely: semmit, a név hosszát, az első betűjét, vagy az általad írt tippet.
Lehetséges értékek nonelengthfirst_letterhint
Alapérték: "none"
list_arrange
opcionális a settings objektumban
string
stringCsoportonként egy oszlop, vagy egyetlen lista.
Lehetséges értékek groupsone_list
Alapérték: "groups"
list_allow_give_up
opcionális a settings objektumban
boolean
booleanEgy feladás gombot jelenít meg, amely befejezi a menetet, és felfedi, mi maradt ki.
Alapérték: false
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "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"
}
Szerkesztő megnyitása Vissza a tetejére
Kártyák és párok

Memory

Lefordított kártyák, amelyeket fel kell fordítani és párba állítani.

#
POST /api/public/v1/memory 2–30 elem az items tömbben
Tartalom

Párok tömbje. Minden pár azt a két kártyát tartalmazza, amelyek összetartoznak.

Tartaléknév: “Memory Game API”

Jó tudni
  • Egy kártya olyan objektum, amelynek van type és value mezője. Szavakhoz használd a "text" értéket, vagy az "image", "audio", "youtube" és "link" valamelyikét egy URL-lel a value mezőben, és add meg az alt mezőt a leíráshoz.
Példakérés
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": "hu",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "Apple"
        },
        {
          "type": "text",
          "value": "A red fruit"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "A yellow fruit"
        }
      ]
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/memory/embed?p=-Nq8sample_activity_key",
  "message": "Memory game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Hozzárendelés

api_e_matching_pairs

#
POST /api/public/v1/matching-pairs 2–30 elem az items tömbben
Tartalom

api_c_matching_pairs

Tartaléknév: “Matching Game API”

Jó tudni
  • Egy kártya olyan objektum, amelynek van type és value mezője. Szavakhoz használd a "text" értéket, vagy az "image", "audio", "youtube" és "link" valamelyikét egy URL-lel a value mezőben, és add meg az alt mezőt a leíráshoz.
Példakérés
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": "hu",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "Apple"
        },
        {
          "type": "text",
          "value": "A red fruit"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "A yellow fruit"
        }
      ]
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/matching-pairs/embed?p=-Nq8sample_activity_key",
  "message": "Matching pairs game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Tanulókártyák

api_e_flash_cards

#
POST /api/public/v1/flash-cards 1–150 elem az items tömbben
Tartalom

api_c_flash_cards

Tartaléknév: “Flash Cards API”

Jó tudni
  • A végpont annyi kártyát tárol, amennyit küldesz, ezért elemenként pontosan kettőt küldj — előbb az előlapot, aztán a hátlapot.
  • Egy kártya olyan objektum, amelynek van type és value mezője. Szavakhoz használd a "text" értéket, vagy az "image", "audio", "youtube" és "link" valamelyikét egy URL-lel a value mezőben, és add meg az alt mezőt a leíráshoz.
Példakérés
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": "hu",
  "items": [
    {
      "cards": [
        {
          "type": "text",
          "value": "Apple"
        },
        {
          "type": "text",
          "value": "A red fruit"
        }
      ]
    },
    {
      "cards": [
        {
          "type": "text",
          "value": "Banana"
        },
        {
          "type": "text",
          "value": "A yellow fruit"
        }
      ]
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/flash-cards/embed?p=-Nq8sample_activity_key",
  "message": "Flash Cards created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Csoportosítás

Kártyák, amelyeket a hozzájuk tartozó csoportba kell rendezni.

#
POST /api/public/v1/categorize Legalább 2 elem az items tömbben · legfeljebb 60 kártya összesen
Tartalom

Kategóriák tömbje, mindegyiknél egy név és a hozzá tartozó kártyák.

Tartaléknév: “Categorize Game API”

Jó tudni
  • A név nélkül küldött kategória az “Untitled Category” nevet kapja, ezért mindig adj meg nevet.
  • Egy kártya olyan objektum, amelynek van type és value mezője. Szavakhoz használd a "text" értéket, vagy az "image", "audio", "youtube" és "link" valamelyikét egy URL-lel a value mezőben, és add meg az alt mezőt a leíráshoz.
Példakérés
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": "hu",
  "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"
        }
      ]
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/categorize/embed?p=-Nq8sample_activity_key",
  "message": "Categorize game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Sorrendrejtvény

Sorozat, amelyet a játékosoknak helyes sorrendbe kell tenniük.

#
POST /api/public/v1/reorder Legalább 1 elem az items tömbben · legfeljebb 60 kártya összesen
Tartalom

Sorozatok tömbje. Mindegyik a helyes sorrendben tartalmazza a kártyáit.

Tartaléknév: “Reorder Game API”

Jó tudni
  • Az általad küldött sorrend lesz a helyes sorrend — az első elem elöl.
  • Egy kártya olyan objektum, amelynek van type és value mezője. Szavakhoz használd a "text" értéket, vagy az "image", "audio", "youtube" és "link" valamelyikét egy URL-lel a value mezőben, és add meg az alt mezőt a leíráshoz.
Példakérés
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": "hu",
  "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"
        }
      ]
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/reorder/embed?p=-Nq8sample_activity_key",
  "message": "Reorder game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Bingo

Osztálybingó, amelyet a játékvezető élőben mond be: minden játékos az elemeidből húzott kártyát kap.

#
POST /api/public/v1/bingo Nem fogad items elemeket
Tartalom

Elemek tömbje, amelyből a kártyák készülnek. Küldj egy kártya mezőinél érezhetően több elemet, hogy a kártyák különbözzenek.

Tartaléknév: “Bingo API”

Jó tudni
  • Az elem olyan objektum, amelynek van value mezője, és opcionálisan type ("text", "image" vagy "audio", az URL a value mezőben), description (a nyom, amelyet a játékvezető nyomok módban felolvas) és alt mezője.
Beolvasott beállítások
MezőTípusMit csinál
mode
opcionális a settings objektumban
string
stringMi tölti ki a mezőket: az elemeid, az elemeid a nyomuk alapján bemondva, vagy sima számok (ezekhez nem kell elem).
Lehetséges értékek itemscluesnumbers
Alapérték: "items"
rows
opcionális a settings objektumban
number
numberSorok száma egy kártyán, 2 és 5 között.
Alapérték: 3
columns
opcionális a settings objektumban
number
numberOszlopok száma egy kártyán, 2 és 5 között.
Alapérték: 3
highest_number
opcionális a settings objektumban
number
numberSzámok módban a kártyákat 1-től eddig a számig töltjük ki, legfeljebb 100-ig. Csomaghoz kötött funkció: csomag nélkül 50 marad.
Alapérték: 50
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/bingo/embed?p=-Nq8sample_activity_key",
  "message": "Bingo created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Nekem van, kinek van

api_e_i_have_who_has

#
POST /api/public/v1/i-have-who-has 3–40 elem az items tömbben
Tartalom

api_c_i_have_who_has

Tartaléknév: “I Have, Who Has API”

Jó tudni
  • Egyetlen kérdés és egyetlen válasz sem szerepelhet kétszer: aki a választ tartja a kezében, nem tudná eldönteni, melyik kérdéshez tartozik.
Beolvasott beállítások
MezőTípusMit csinál
chain_shape
opcionális a settings objektumban
string
stringA kör önmagába zárul, így bármelyik kártyával indulhat a játék; a vonal egy Start kártyával nyílik, és egy End kártyával ér véget.
Lehetséges értékek loopline
Alapérték: "loop"
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "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"
}
Szerkesztő megnyitása Vissza a tetejére

Számzár

Számzár: egy kártyákból álló pad, amelynek néhány kártyája együtt adja a kódot.

#
POST /api/public/v1/keypad 1–30 elem az items tömbben
Tartalom

Kártyák tömbje. A kódban szereplő kártyák megadják a helyüket a kódban.

Tartaléknév: “Keypad API”

Jó tudni
  • A kártya olyan objektum, amelynek van value mezője, és opcionálisan type ("text", "image" vagy "audio", az URL a value mezőben), alt és code_position mezője: a helye a kódban, az 1 az első. Egy kártya egyszer szerepelhet a kódban, és legalább egy kártyának benne kell lennie.
Beolvasott beállítások
MezőTípusMit csinál
instructions
opcionális a settings objektumban
string
stringA kérdés vagy talány, amelyre a kód a válasz, a pad mellett megjelenítve.
force_solution_in_correct_order
opcionális a settings objektumban
boolean
booleanA kártyákat sorrendben kell megnyomni. Kikapcsolva a helyes kártyák bármilyen sorrendje kinyitja a zárat.
Alapérték: false
randomize_order
opcionális a settings objektumban
boolean
booleanMinden játékos összekevert elrendezésben kapja a kártyákat.
Alapérték: true
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/keypad/embed?p=-Nq8sample_activity_key",
  "message": "Keypad created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Kvartett

A kártyajáték: a játékosok kártyákat kérnek egymástól, hogy négyes sorozatokat gyűjtsenek.

#
POST /api/public/v1/quartets 2–16 elem az items tömbben
Tartalom

Kvartettek tömbje. Mindegyiknek van neve és pontosan négy kártyája.

Tartaléknév: “Quartets API”

Jó tudni
  • A kártya egy név, vagy egy olyan objektum, amelynek van name és description mezője (a rajta látható tény). Egy kártyanév sem szerepelhet kétszer a játékban: a játékosok név szerint kérnek kártyát.
Beolvasott beállítások
MezőTípusMit csinál
type
opcionális a settings objektumban
string
stringSima játék, vagy tanulójáték, amelyben minden kártya egy tényt mutat. Ha kihagyod, learn lesz, ha bármelyik kártyának van description mezője.
Lehetséges értékek normallearn
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/quartets/embed?p=-Nq8sample_activity_key",
  "message": "Quartets game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére
Kérdések és válaszok

Quiz

Feleletválasztós és nyílt kérdések, menet közbeni pontozással.

#
POST /api/public/v1/quiz 1–100 elem az items tömbben
Tartalom

Kérdések tömbje. A feleletválasztós kérdések a válaszlehetőségeiket hozzák; a nyílt kérdések azt a választ, amelyet elfogadsz.

Tartaléknév: “Quiz API”

Jó tudni
  • A question_type értéke "multiple_choice", ahol a helyes opció isCorrect értéke true; "true_false", ugyanez pontosan két opcióval, az első az igaz, a második a hamis; vagy "open_answer", ami helyette a correct_answer mezőt használja. Ha kimarad, feleletválasztósnak számít.
  • A Quiz végpont a settings tartalmát közvetlenül tevékenységbeállítás-blokkokként adja tovább, tehát ide nem valók szabadon szórt opciók — a Quiz-t utólag a szerkesztőben állítsd be.
Példakérés
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": "hu",
  "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."
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/quiz/embed?p=-Nq8sample_activity_key",
  "message": "Quiz created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Társasjáték

api_e_board_game

#
POST /api/public/v1/board-game 1–100 elem az items tömbben
Tartalom

api_c_board_game

Tartaléknév: “Board Game API”

Jó tudni
  • A question_type értéke "multiple_choice", ahol a helyes opció isCorrect értéke true; "true_false", ugyanez pontosan két opcióval, az első az igaz, a második a hamis; vagy "open_answer", ami helyette a correct_answer mezőt használja. Ha kimarad, feleletválasztósnak számít.
Beolvasott beállítások
MezőTípusMit csinál
number_of_tiles
opcionális a settings objektumban
number
numberHány mezője van a táblának. 10 és 75 között.
Alapérték: 30
game_mode
opcionális a settings objektumban
string
stringA játékosok a célba érésért versenyeznek, vagy útközben tárgyakat gyűjtenek.
Lehetséges értékek race_to_finishcollect_items
Alapérték: "race_to_finish"
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/board-game/embed?p=-Nq8sample_activity_key",
  "message": "Board Game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Labirintus

Bejárandó labirintus: minden kérdés egy terem, a válaszok pedig az ajtók.

#
POST /api/public/v1/maze Legalább 1 elem az items tömbben
Tartalom

Feleletválasztós vagy igaz-hamis kérdések tömbje, pontosan olyan alakban, ahogy a Quiz végpont fogadja. A nyílt kérdéseket elutasítjuk: egy ajtóra rá kell írni a választ.

Tartaléknév: “Maze API”

Beolvasott beállítások
MezőTípusMit csinál
maze_width
opcionális a settings objektumban
string
stringHogyan helyezkednek el a termek: egy oszlopban, négyzetben vagy szélesebben.
Lehetséges értékek narrownormalwide
Alapérték: "normal"
maze_corridors
opcionális a settings objektumban
string
stringMennyi labirintus fekszik két kérdés között.
Lehetséges értékek shortnormallong
Alapérték: "normal"
maze_fog
opcionális a settings objektumban
string
stringAz egész labirintust mutatja, vagy csak azt, ami mellett a játékos már járt.
Lehetséges értékek offnear
Alapérték: "off"
maze_wrong_door_pause
opcionális a settings objektumban
string
stringMennyi ideig maradnak zárva az ajtók egy rossz ajtó után.
Lehetséges értékek noneshortlong
Alapérték: "short"
maze_walk_there
opcionális a settings objektumban
boolean
booleanEgy gombot kínál, amely a bábut a következő terembe viszi.
Alapérték: false
maze_seed
opcionális a settings objektumban
string
stringA mag, amelyből a labirintus készül. Ugyanaz a mag és ugyanazok a kérdések ugyanazt a labirintust adják; ha kihagyod, újat húzunk.
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/maze/embed?p=-Nq8sample_activity_key",
  "message": "Maze created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Jeopardy

Vetélkedőtábla: felül a kategóriák, alattuk a meghatározások, amelyek annál többet érnek, minél lejjebb ülnek.

#
POST /api/public/v1/jeopardy Legalább 2 elem az items tömbben
Tartalom

Kategóriák tömbje, balról jobbra. Mindegyiknek van neve és a meghatározásai a felső sortól lefelé.

Tartaléknév: “Jeopardy API”

Jó tudni
  • A meghatározás olyan kérdés, ahogy a Quiz végpont fogadja, open_answer, hacsak mást nem jelzel, a correct_answer mezővel és opcionálisan aliases mezővel. Hordozhat value (saját értéke) és daily_double mezőt is. A null üresen hagy egy cellát.
Beolvasott beállítások
MezőTípusMit csinál
jeopardy_buzzer_mode
opcionális a settings objektumban
string
stringKi hogyan játszik: a játékvezető a konzolról vezeti, a játékosok a telefonjukról jelentkeznek, vagy mindenki egyedül dolgozik a táblán.
Lehetséges értékek hostphonessolo
Alapérték: "host"
jeopardy_contestants
opcionális a settings objektumban
string
stringA konzol csapatokról vagy játékosokról beszél-e.
Lehetséges értékek teamsplayers
Alapérték: "teams"
jeopardy_value_step
opcionális a settings objektumban
number
numberMennyit ér egy sor: a meghatározás értéke ennek és a sor számának a szorzata. 50-től 500-ig, 50-es lépésekben.
Alapérték: 100
jeopardy_answer_time
opcionális a settings objektumban
number
numberMásodpercek a válaszadásra, miután megnyílt egy meghatározás, legfeljebb 300. A 0 azt jelenti, hogy nincs óra.
Alapérték: 20
jeopardy_wrong_answer_costs
opcionális a settings objektumban
boolean
booleanEgy rossz válasz levonja a meghatározás értékét a pontszámból.
Alapérték: false
jeopardy_reveal_on_timeout
opcionális a settings objektumban
boolean
booleanA tábla maga mutatja meg a választ, amikor lejár az idő.
Alapérték: false
jeopardy_require_question_form
opcionális a settings objektumban
boolean
booleanEmlékezteti a játékosokat, hogy kérdés formájában válaszoljanak.
Alapérték: false
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/jeopardy/embed?p=-Nq8sample_activity_key",
  "message": "Jeopardy board created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Interaktív videó

api_e_interactive_video

#
POST /api/public/v1/interactive-video 1–50 elem az items tömbben
Tartalom

api_c_interactive_video

Tartaléknév: “Interactive Video API”

Jó tudni
  • A felugró elem olyan objektum, amelynek van time (másodperc, vagy "1:23"), kind ("question", hacsak nem "note", "think" vagy "chapter" áll ott) és description mezője. A kérdés olyan kérdés, ahogy a Quiz végpont fogadja, és hordozhat rewind_to mezőt: innen játssza újra a videót egy rossz válasz után.
Beolvasott beállítások
MezőTípusMit csinál
video_url
kötelező a settings objektumban
string
stringA videó: egy YouTube-, Vimeo- vagy Bunny Stream-oldal, vagy egy mp4-, webm- vagy mov-fájl közvetlen linkje.
video_duration
opcionális a settings objektumban
number
numberA videó hossza másodpercben. Ha megadod, a videó vége utánra eső felugró elemet elutasítjuk.
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/interactive-video/embed?p=-Nq8sample_activity_key",
  "message": "Interactive video created successfully"
}
Szerkesztő megnyitása Vissza a tetejére
Mondatok és számok

Kriptogram

Feltörendő kóddá alakít egy mondatot, karakterről karakterre.

#
POST /api/public/v1/cryptogram Nem fogad items elemeket
Tartalom

Egyetlen mondat, a sentence mezőben. Ez a végpont nem fogad items elemeket.

Tartaléknév: “Cryptogram API”

Jó tudni
  • Amit az items mezőben küldesz, azt figyelmen kívül hagyjuk — a rejtvény kizárólag a mondatból épül.
Beolvasott beállítások
MezőTípusMit csinál
sentence
kötelező
string
stringA titkosítandó mondat. A játékosok karakterről karakterre fejtik meg.
helpers
opcionális a settings objektumban
string
stringMely karaktereket kapják meg a játékosok ingyen, kiindulásként: egyet sem, a leggyakoribbakat, a magánhangzókat, vagy azokat, amelyeket te sorolsz fel.
Lehetséges értékek nonemost_commonvowelscustom
Alapérték: "none"
character_list
opcionális a settings objektumban
string
stringAz ábécé, amelyből a rejtjel épül. Ha üresen hagyod, a titkosítás maga választ.
extra_letters
opcionális a settings objektumban
string
stringAzok a karakterek, amelyeket a játékosok megkapnak, ha a helpers értéke "custom". A többi segítségmódnál nincs hatása.
hide_unused_characters
opcionális a settings objektumban
boolean
booleanKihagyja a kulcsból azokat a karaktereket, amelyeket a mondat nem használ.
Alapérték: false
Példakérés
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": "hu",
  "sentence": "An apple a day keeps the doctor away",
  "settings": {
    "helpers": "vowels",
    "hide_unused_characters": false
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/cryptogram/embed?p=-Nq8sample_activity_key",
  "message": "Cryptogram created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Számolórejtvény

Műveletek mögé rejt egy mondatot — oldd meg a műveletet, és előbukkan a betű.

#
POST /api/public/v1/calculation Nem fogad items elemeket
Tartalom

Egyetlen mondat, a sentence mezőben. Ez a végpont nem fogad items elemeket.

Tartaléknév: “Calculation Game API”

Jó tudni
  • Ha a korlátok túl szűkek a mondat kódolásához, a hívás 400-zal válaszol, és lazítást kér, ahelyett hogy félkész rejtvényt mentene.
Beolvasott beállítások
MezőTípusMit csinál
sentence
kötelező
string
stringA mondat, amelyet a játékosok a műveletek megoldásával fednek fel.
difficulty_level
opcionális a settings objektumban
number
numberA legnagyobb eredmény, amely egy műveletnél előfordulhat.
Lehetséges értékek 20501001000
Alapérték: "100"
operators
opcionális a settings objektumban
string[]
string[]Mely műveletek jelenhetnek meg. Az x a szorzás, a : az osztás.
Lehetséges értékek +-x:
Alapérték: ["+", "-", "x", ":"]
max_operations
opcionális a settings objektumban
number
numberHány műveletet fűzhet össze egy feladat.
Lehetséges értékek 123
Alapérték: 1
number_difficulty
opcionális a settings objektumban
number
numberKorlátozza a műveleten belüli egyes számokat. 5-től 1000-ig bármi lehet.
Alapérték: 100
Példakérés
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": "hu",
  "sentence": "Fruit salad for everyone",
  "settings": {
    "difficulty_level": "100",
    "operators": [
      "+",
      "-",
      "x",
      ":"
    ],
    "max_operations": 1,
    "number_difficulty": 100
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/calculation/embed?p=-Nq8sample_activity_key",
  "message": "Calculation game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Sudoku

Megoldott rácsot készít, majd számokat vesz ki belőle.

#
POST /api/public/v1/sudoku Nem fogad items elemeket
Tartalom

Semmi. Az egész rejtvény a két beállításából jön ki.

Tartaléknév: “Sudoku API”

Jó tudni
  • Ne küldj sem items, sem sentence mezőt — a méret és a nehézség a teljes bemenet.
  • A szerkesztő csak 2x3, 3x3 és 3x4 méretnél kínálja a nehézséget. Az API minden méretnél alkalmazza, a 2x2-t és a 4x4-et is beleértve.
Beolvasott beállítások
MezőTípusMit csinál
size
opcionális a settings objektumban
string
stringEgy blokk mérete, sorok és oszlopok formájában — a 3x3 adja a klasszikus 9x9-es rácsot. A végpont csak azt ellenőrzi, hogy két számként értelmezhető-e, ezért maradj azoknál a méreteknél, amelyeket a szerkesztő kínál.
Lehetséges értékek 2x22x33x33x44x4
Alapérték: "3x3"
difficulty_level
opcionális a settings objektumban
string
stringHány szám marad a táblán kiindulásként.
Lehetséges értékek easynormalhard
Alapérték: "normal"
Példakérés
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": "hu",
  "settings": {
    "size": "3x3",
    "difficulty_level": "normal"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/sudoku/embed?p=-Nq8sample_activity_key",
  "message": "Sudoku created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Hullómondat

api_e_fallen_phrase

#
POST /api/public/v1/fallen-phrase Nem fogad items elemeket
Tartalom

api_c_fallen_phrase

Tartaléknév: “Fallen Phrase API”

Beolvasott beállítások
MezőTípusMit csinál
sentence
kötelező
string
stringAz elrejtendő mondat: egy idézet, egy közmondás, egy kulcsmondat. Legfeljebb 120 betű és számjegy.
columns
opcionális a settings objektumban
number
numberMilyen széles a tábla, 8 és 18 között. Minél keskenyebb, annál több betű kerül egy oszlopba, és annál nehezebb.
Alapérték: 14
helpers
opcionális a settings objektumban
string
stringMely betűk maradnak a rácsban kiindulásként: egy sem, a leggyakoribbak, a magánhangzók, vagy azok, amelyeket te sorolsz fel.
Lehetséges értékek nonemost_commonvowelscustom
Alapérték: "none"
extra_letters
opcionális a settings objektumban
string
stringAz ingyen megadott betűk, ha a helpers értéke "custom".
Példakérés
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": "hu",
  "sentence": "Don't count your chickens before they hatch.",
  "settings": {
    "columns": 12,
    "helpers": "custom",
    "extra_letters": "ky"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/fallen-phrase/embed?p=-Nq8sample_activity_key",
  "message": "Fallen phrase created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Szorzótábla

api_e_times_tables

#
POST /api/public/v1/times-tables Nem fogad items elemeket
Tartalom

api_c_times_tables

Tartaléknév: “Times Tables API”

Beolvasott beállítások
MezőTípusMit csinál
tables
opcionális a settings objektumban
number[]
number[]A gyakorolandó szorzótáblák. Ha kihagyod, 1-től 10-ig tart; a 11 vagy a 12 a rácsot 12×12-esre teszi.
Lehetséges értékek 123456789101112
order
opcionális a settings objektumban
string
stringA sorok és az oszlopok sorrendben vagy összekeverve követik-e egymást.
Lehetséges értékek ascendingshuffled
Alapérték: "ascending"
picture
opcionális a settings objektumban
string
stringA kép, amelyet a helyes válaszok kifestenek.
Lehetséges értékek sailboatheartrockettreecatfishflowerhouse
Alapérték: "sailboat"
players_choose_tables
opcionális a settings objektumban
boolean
booleanLehetővé teszi, hogy minden játékos maga válassza ki, melyik szorzótáblákat gyakorolja.
Alapérték: false
fill_same_sums
opcionális a settings objektumban
boolean
booleanEgy helyes válasz minden azonos szorzatú mezőt kitölt.
Alapérték: true
Példakérés
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": "hu",
  "settings": {
    "tables": [
      7,
      3,
      4
    ],
    "order": "shuffled",
    "seed": "k3x9q2ab",
    "picture": "rocket",
    "players_choose_tables": true,
    "fill_same_sums": false
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/times-tables/embed?p=-Nq8sample_activity_key",
  "message": "Times tables created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Szövegkiegészítés

api_e_fill_in_the_gap

#
POST /api/public/v1/fill-in-the-gap 1–50 elem az items tömbben
Tartalom

api_c_fill_in_the_gap

Tartaléknév: “Fill in the gap API”

Jó tudni
  • Írd le a teljes mondatot, és tedd csillagok közé a kihagyandó szavakat: "Water boils at *100* degrees." Egy csillagpáron belül több szó is egyetlen hézag. Egy elem a mondat fölött megjelenő utasítást is hordozhat.
Példakérés
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": "hu",
  "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."
    }
  ]
}'
Siker 
{
  "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"
}
Szerkesztő megnyitása Vissza a tetejére

Mondatelemzés

Olyan mondatok, amelyekben a játékosok megcímkézik a szavakat: szófajokkal, mondatrészekkel vagy a saját címkéiddel.

#
POST /api/public/v1/deconstruct 1–50 elem az items tömbben
Tartalom

Mondatok tömbje. Minden megcímkézendő szó [word](label) alakban van leírva.

Tartaléknév: “Sentence analysis API”

Jó tudni
  • Egy mondatot így írj le: "The [dog](noun) [barks](verb)." A címke nélküli szavak megjelennek, de nem kérdezzük őket. A noun, verb, adjective és subject címkéket minden játékos a saját nyelvén látja.
Beolvasott beállítások
MezőTípusMit csinál
categories
opcionális a settings objektumban
string[]
string[]A címkék, amelyek közül a játékosok választanak, sorrendben. Ha kihagyod, a mondatokban használt címkék lesznek. Akkor add meg, ha olyan címkét is fel akarsz venni, amelyet egyetlen szó sem visel, vagy ha a sorrendet akarod meghatározni.
Példakérés
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": "hu",
  "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"
    ]
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/deconstruct/embed?p=-Nq8sample_activity_key",
  "message": "Sentence analysis created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Logikai rejtvény

api_e_logic_puzzle

#
POST /api/public/v1/logic-puzzle Legalább 3 elem az items tömbben
Tartalom

api_c_logic_puzzle

Tartaléknév: “Logic Puzzle API”

Jó tudni
  • Minden kategóriának ugyanannyi, 3 és 6 közötti, egymástól különböző eleme kell legyen. Egy kategória megjelölhető rendezettként (árak, időpontok, életkorok), opcionális unit mezővel, amely lehetővé teszi, hogy a generátor nyomokat írjon a többről, a kevesebbről és a különbség mértékéről.
Beolvasott beállítások
MezőTípusMit csinál
story
opcionális a settings objektumban
string
stringA nyomok fölött megjelenő háttértörténet.
difficulty
opcionális a settings objektumban
string
stringA generátor milyen fajta nyomokat használhat.
Lehetséges értékek easymediumhard
Alapérték: "easy"
hints
opcionális a settings objektumban
boolean
booleanEgy gombot kínál, amely megmutatja a következő lépést.
Alapérték: true
auto_cross
opcionális a settings objektumban
boolean
booleanEgy egyezés megjelölése áthúzza a sor és az oszlop többi celláját.
Alapérték: true
clue_mode
opcionális a settings objektumban
string
stringKi írja a játékosok által látott nyomokat: a táblázatból generáltak, a free_clues mezőben megadott saját mondataid, vagy egy sem.
Lehetséges értékek generatedfreenone
Alapérték: "generated"
free_clues
opcionális a settings objektumban
string[]
string[]A saját nyommondataid, úgy megjelenítve, ahogy leírtad, a clue_mode "free" értékével. Semmi sem ellenőrzi őket.
Példakérés
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": "hu",
  "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"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/logic-puzzle/embed?p=-Nq8sample_activity_key",
  "message": "Logic puzzle created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Kincsvadászat

api_e_scavenger_hunt

#
POST /api/public/v1/scavenger-hunt 1–50 elem az items tömbben
Tartalom

api_c_scavenger_hunt

Tartaléknév: “Scavenger Hunt API”

Jó tudni
  • A lépés olyan objektum, amelynek van title, description, code és opcionálisan accepted_codes (más elfogadott írásmódok), url és link_text mezője. A kódot a nagybetűk és a szóközök figyelmen kívül hagyásával ellenőrizzük. A térképet a jelölőkkel csak a szerkesztőben lehet hozzáadni.
Példakérés
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": "hu",
  "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"
      ]
    }
  ]
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/scavenger-hunt/embed?p=-Nq8sample_activity_key",
  "message": "Scavenger hunt created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Térlátás

api_e_spatial_reasoning

#
POST /api/public/v1/spatial-reasoning 1–50 elem az items tömbben
Tartalom

api_c_spatial_reasoning

Tartaléknév: “Spatial Reasoning API”

Jó tudni
  • Az objektumok és a célok: square, triangle, circle, hexagon, pentagon, star, diamond vagy heart. A viszonyok: inside, outside, behind, in_front_of, right_of, left_of, above, below, same_color_as, different_color_from, larger_than és smaller_than. Egy soha nem teljesíthető szabály 400-as hibát ad.
Beolvasott beállítások
MezőTípusMit csinál
clue_mode
opcionális a settings objektumban
string
stringA szabályok képként vagy mondatként jelennek meg.
Lehetséges értékek visualtext
Alapérték: "visual"
unique_object_picks
opcionális a settings objektumban
boolean
booleanMinden alakzatot csak egyszer lehet elhelyezni.
Alapérték: false
hide_color_picker
opcionális a settings objektumban
boolean
booleanA játékosok nem színezhetik át az alakzatokat.
Alapérték: false
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/spatial-reasoning/embed?p=-Nq8sample_activity_key",
  "message": "Spatial reasoning activity created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Rébusz

Képként leírt mondatok: a játékosok a képeket és a betűváltásokat olvassák vissza szavakká.

#
POST /api/public/v1/rebus 1–30 elem az items tömbben
Tartalom

Mondatok tömbje. Mindegyik felsorolja a képként megrajzolt szavakat; minden más szó betűkként marad.

Tartaléknév: “Rebus API”

Jó tudni
  • A szót olyan részekből rajzoljuk, amelyek együtt kiadják. Egy résznek van betűsora, amelyet helyettesít (text), egy emojija, és a shows mezője: annak a szónak a leírása, amit a kép mutat ("broom" egy olyan képhez, amely a "room" szót jelenti). A Puzzel kiszámolja a betűváltásokat. Egy rész lehet szimbólum is, például 4 a "for" helyett.
Beolvasott beállítások
MezőTípusMit csinál
rebus_commas
opcionális a settings objektumban
boolean
booleanAz elhagyott első vagy utolsó betűt vesszőként rajzolja a kép mellé.
Alapérték: false
Példakérés
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": "hu",
  "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
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/rebus/embed?p=-Nq8sample_activity_key",
  "message": "Rebus created successfully"
}
Szerkesztő megnyitása Vissza a tetejére
Képek

Kirakó

Darabokra vágja a képet, hogy vissza lehessen húzogatni őket egymáshoz.

#
POST /api/public/v1/jigsaw Nem fogad items elemeket
Tartalom

Egyetlen kép-URL, az image mezőben. Ez a végpont nem fogad items elemeket.

Tartaléknév: “Jigsaw Game API”

Jó tudni
  • Az API mindig 4x4-es kirakót készít. A darabszám, a szabálytalan darabok és az egyenes élek szerkesztőbeli beállítások — a rows vagy a columns küldésének itt nincs hatása.
  • Az URL-t úgy tároljuk, ahogy elküldted, és a fájlt sosem másoljuk le, ezért nyilvánosan elérhetőnek kell maradnia mindaddig, amíg a tevékenységgel játszanak.
Beolvasott beállítások
MezőTípusMit csinál
image
kötelező
string
stringA feldarabolandó kép abszolút URL-je. A legfelső szinten küldd, ne a settings objektumban.
Példakérés
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": "hu",
  "image": "https://example.com/orchard.jpg"
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/jigsaw/embed?p=-Nq8sample_activity_key",
  "message": "Jigsaw game created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Tolókirakó

Csúsztatható lapkákra keveri szét a képet.

#
POST /api/public/v1/slidingpuzzle Nem fogad items elemeket
Tartalom

Egyetlen kép-URL, a settings objektumban. Ez a végpont nem fogad items elemeket.

Tartaléknév: “Sliding Puzzle API”

Jó tudni
  • A kirakóval ellentétben ez a végpont a settings.image mezőből olvassa a képet. A legfelső szintű image mezőt figyelmen kívül hagyja, és a hívás 400-zal válaszol.
  • Az URL-t úgy tároljuk, ahogy elküldted, és a fájlt sosem másoljuk le, ezért nyilvánosan elérhetőnek kell maradnia mindaddig, amíg a tevékenységgel játszanak.
Beolvasott beállítások
MezőTípusMit csinál
image
kötelező a settings objektumban
string
stringAz összekeverendő kép abszolút URL-je. A kirakóval ellentétben ez a settings objektumban van.
Példakérés
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": "hu",
  "settings": {
    "image": "https://example.com/orchard.jpg"
  }
}'
Siker 
{
  "success": true,
  "id": "-Nq8sample_activity_key",
  "url": "https://puzzel.org/en/slidingpuzzle/embed?p=-Nq8sample_activity_key",
  "message": "Sliding puzzle created successfully"
}
Szerkesztő megnyitása Vissza a tetejére

Valami nem úgy működik, ahogy kéne?

Küldd el a kérést, amit kipróbáltál, és a hibát, amit visszakaptál, és valódi választ kapsz attól, aki a végpontot írta.

E-mail a támogatásnak