Cartes de bingo Référence de l’API

Cartes de bingo: Cette référence tire les modes, modèles, formats et champs du registre et du contrat utilisés par l’API.

Clés 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": "bingo", "title": "Party bingo", "input": { "words": [ "APPLE", "BANANA", "CHERRY", "DATE", "FIG", "GRAPE", "KIWI", "LEMON", "MANGO" ] }, "options": { "gridSize": 3, "cardCount": 1 } }'

Modes

classic · signature · number · blank

Modèles de pages

Formats exportés dans le navigateur

pdf · caller-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

Champ	Valeur acceptée	Obligatoire
preset	texte	Non
mode	texte	Non
locale	au choix; en \| zh \| es \| de \| fr \| pt \| it \| id \| ja \| ko	Non
contentLanguage	au choix; en \| zh \| es \| de \| fr \| pt \| it \| id \| ja \| ko	Non
title	texte	Oui
retentionDays	nombre; entier	Non
appearance.themeColor	texte	Non
appearance.title.fontFamily	au choix; sans \| serif \| handwriting \| playful \| mono	Non
appearance.title.fontWeight	au choix; normal \| medium \| semibold \| bold \| extrabold	Non
appearance.title.color	texte	Non
appearance.title.align	au choix; left \| center \| right	Non
appearance.title.maxFontSize	nombre; minimum 6; maximum 120	Non
appearance.grid.shape	au choix; square \| circle	Non
appearance.grid.corners	au choix; sharp \| sm \| md \| lg	Non
appearance.grid.gap	au choix; none \| sm \| md \| lg	Non
appearance.grid.colorMode	au choix; mono \| checker	Non
appearance.grid.bg	au choix; texte \| transparent \| object	Non
appearance.grid.textFontFamily	au choix; sans \| serif \| handwriting \| playful \| mono	Non
appearance.grid.textFontWeight	au choix; normal \| medium \| semibold \| bold \| extrabold	Non
appearance.grid.textColor	texte	Non
appearance.grid.borderWidth	nombre; entier; minimum 0; maximum 3	Non
appearance.grid.borderColor	texte	Non
appearance.grid.borderStyle	au choix; solid \| dashed \| dotted	Non
appearance.card.bgColor	au choix; texte \| transparent \| object	Non
appearance.card.borderRadius	au choix; sharp \| rounded	Non
appearance.card.borderWidth	nombre; entier; minimum 0; maximum 3	Non
appearance.card.borderColor	texte	Non
appearance.header.bgColor	au choix; texte \| transparent \| object	Non
appearance.header.fontFamily	au choix; sans \| serif \| handwriting \| playful \| mono	Non
appearance.header.fontWeight	au choix; normal \| medium \| semibold \| bold \| extrabold	Non
appearance.header.color	texte	Non
appearance.header.maxFontSize	nombre; minimum 6; maximum 120	Non
appearance.footer.enabled	vrai/faux	Non
appearance.footer.text	texte; maximum 200	Non
appearance.footer.fontFamily	au choix; sans \| serif \| handwriting \| playful \| mono	Non
appearance.footer.fontWeight	au choix; normal \| medium \| semibold \| bold \| extrabold	Non
appearance.footer.color	texte	Non
appearance.footer.align	au choix; left \| center \| right	Non
appearance.footer.maxFontSize	nombre; minimum 6; maximum 120	Non
appearance.columnHeaders	liste; maximum 5	Non
appearance.columnHeaders[]	texte; minimum 1; maximum 8	Non
appearance.showColumnHeaders	vrai/faux	Non
appearance.randomization	au choix; full \| column	Non
appearance.freeSpaceLabel	texte; maximum 40	Non
appearance.signatureLines	vrai/faux	Non
appearance.fontFamily	au choix; sans \| serif \| handwriting \| playful \| mono	Non
appearance.fontSize	au choix; small \| medium \| large	Non
appearance.headerBgColor	texte	Non
appearance.showGridLines	vrai/faux	Non
appearance.outerBorder	vrai/faux	Non
appearance.borderStyle	au choix; solid \| dashed \| dotted	Non
export.paperSize	au choix; A3 \| A4 \| A4-landscape \| A5 \| B5 \| Letter \| Letter-landscape \| Legal \| Half-Letter \| Tabloid \| custom	Non
export.widthMm	nombre; minimum 50; maximum 2000	Non
export.heightMm	nombre; minimum 50; maximum 2000	Non
export.unit	au choix; mm \| cm \| in \| px	Non
export.quality	au choix; standard \| high \| print	Non
export.layout	au choix; 1x1 \| 1x2 \| 2x2 \| 2x4	Non
input.words	liste; minimum 1; maximum 200	Non
input.words[]	texte; minimum 1; maximum 50	Non
input.numbers	liste	Non
input.numbers[]	nombre; entier; minimum 0; maximum 9999	Non
options.seed	nombre; entier; minimum 0; maximum 2147483647	Non
options.gridSize	au choix; 3 \| 4 \| 5	Non
options.cardCount	nombre; entier; minimum 1; maximum 100	Non
options.freeSpace	vrai/faux	Non
options.minNumber	nombre; entier; minimum 0; maximum 9999	Non
options.maxNumber	nombre; entier; minimum 0; maximum 9999	Non
options.ballCount	au choix; 30 \| 75 \| 80	Non
options.signatureLine	vrai/faux	Non

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.