Skip to content

Mots mĂ©langĂ©s RĂ©fĂ©rence de l’API

Mots mĂ©langĂ©s: Cette rĂ©fĂ©rence tire les modes, modĂšles, formats et champs du registre et du contrat utilisĂ©s par l’API.

Exemple de requĂȘte

curl -X POST https://puzzlegenio.com/api/v1/puzzles \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Idempotency-Key: task-000000000001' \
  -H 'Content-Type: application/json' \
  -d '{ "type": "scramble", "title": "Animal scramble", "input": { "words": [ "TIGER", "HORSE", "RABBIT" ] } }'

Modes

scramble · double

ModĂšles de pages

Formats exportés dans le navigateur

png · pdf

Les formats dĂ©pendent des rĂ©glages et de l’abonnement. viewUrl et exportPageUrl mĂšnent au tĂ©lĂ©chargement dans le navigateur ; la rĂ©ponse ne contient aucun fichier PDF, PNG ou STL. Les droits sont figĂ©s Ă  la publication et vĂ©rifiĂ©s Ă  nouveau lors d’une republication.

Champs communs

ChampValeur acceptéeObligatoire
presettexteNon
modetexteNon
localeau choix; en | zh | es | de | fr | pt | it | id | ja | koNon
contentLanguageau choix; en | zh | es | de | fr | pt | it | id | ja | koNon
titletexteOui
retentionDaysnombre; entierNon
appearance.fontFamilyau choix; sans | serif | handwriting | playful | monoNon
appearance.themeColortexteNon
appearance.footerTexttexte; maximum 200Non
appearance.borderStyleau choix; solid | dashed | dottedNon
appearance.layoutModeau choix; default | worksheetNon
appearance.pillTitlevrai/fauxNon
appearance.showWorksheetHeadervrai/fauxNon
appearance.outerBordervrai/fauxNon
appearance.titleScalenombre; minimum 0.5; maximum 3Non
appearance.letterCaseau choix; uppercase | lowercaseNon
appearance.answerStyleau choix; boxed | lineNon
appearance.secretShadevrai/fauxNon
appearance.rowSpacingau choix; compact | normal | relaxedNon
appearance.hideInstructionsvrai/fauxNon
export.paperSizeau choix; A3 | A4 | A4-landscape | A5 | B5 | Letter | Letter-landscape | Legal | Half-Letter | Tabloid | customNon
export.widthMmnombre; minimum 50; maximum 2000Non
export.heightMmnombre; minimum 50; maximum 2000Non
export.unitau choix; mm | cm | in | pxNon
export.qualityau choix; standard | high | printNon
input.wordsliste; minimum 1; maximum 20Oui
input.words[]texte; minimum 2; maximum 15Oui
input.secretMessagetexte; maximum 200Non
options.seednombre; entier; minimum 0; maximum 2147483647Non
options.hintModeau choix; none | first-letterNon
options.revealLettersliste; maximum 26Non
options.revealLetters[]texteNon
options.showWordBankvrai/fauxNon

ModĂšles et thĂšmes

Consultez /api/v1/capabilities pour connaĂźtre les modĂšles, thĂšmes et limites de votre compte. Un jeu créé Ă  partir d’un modĂšle occupe aussi une place.

Images et fichiers

Une image est dĂ©signĂ©e par un assetId prĂ©alablement importĂ© ou envoyĂ© depuis le mĂȘme compte. Le tĂ©lĂ©chargement se fait dans le navigateur ; le lien du rĂ©sultat n’est pas un fichier direct.

Cas d’erreur

Les champs inconnus ou les associations incompatibles de type, mode et preset renvoient 422. Une entrée ne permettant pas de produire un jeu complet renvoie également 422. Les formats dépendent des réglages et du compte.

Mots mĂ©langĂ©s RĂ©fĂ©rence de l’API