Buchstabensalate Schnittstellenreferenz
Buchstabensalate: Diese Referenz liest Modi, Vorlagen, Formate und Felder aus demselben Register und Eingabevertrag wie die Schnittstelle.
Beispielanfrage
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" ] } }'Modi
scramble · double
Seitenvorlagen
Exportformate im Browser
png · pdf
Formate richten sich nach Konfiguration und Tarif. viewUrl und exportPageUrl fĂŒhren zum Download im Browser; die Antwort enthĂ€lt keine PDF-, PNG- oder STL-Daten. Berechtigungen werden bei der Veröffentlichung festgelegt und bei erneuter Veröffentlichung geprĂŒft.
Gemeinsame Anfragefelder
| Feld | ZulÀssiger Wert | Pflichtfeld |
|---|---|---|
| preset | Text | Nein |
| mode | Text | Nein |
| locale | einer der Werte; en | zh | es | de | fr | pt | it | id | ja | ko | Nein |
| contentLanguage | einer der Werte; en | zh | es | de | fr | pt | it | id | ja | ko | Nein |
| title | Text | Ja |
| retentionDays | Zahl; Ganzzahl | Nein |
| appearance.fontFamily | einer der Werte; sans | serif | handwriting | playful | mono | Nein |
| appearance.themeColor | Text | Nein |
| appearance.footerText | Text; höchstens 200 | Nein |
| appearance.borderStyle | einer der Werte; solid | dashed | dotted | Nein |
| appearance.layoutMode | einer der Werte; default | worksheet | Nein |
| appearance.pillTitle | wahr/falsch | Nein |
| appearance.showWorksheetHeader | wahr/falsch | Nein |
| appearance.outerBorder | wahr/falsch | Nein |
| appearance.titleScale | Zahl; mindestens 0.5; höchstens 3 | Nein |
| appearance.letterCase | einer der Werte; uppercase | lowercase | Nein |
| appearance.answerStyle | einer der Werte; boxed | line | Nein |
| appearance.secretShade | wahr/falsch | Nein |
| appearance.rowSpacing | einer der Werte; compact | normal | relaxed | Nein |
| appearance.hideInstructions | wahr/falsch | Nein |
| export.paperSize | einer der Werte; A3 | A4 | A4-landscape | A5 | B5 | Letter | Letter-landscape | Legal | Half-Letter | Tabloid | custom | Nein |
| export.widthMm | Zahl; mindestens 50; höchstens 2000 | Nein |
| export.heightMm | Zahl; mindestens 50; höchstens 2000 | Nein |
| export.unit | einer der Werte; mm | cm | in | px | Nein |
| export.quality | einer der Werte; standard | high | print | Nein |
| input.words | Liste; mindestens 1; höchstens 20 | Ja |
| input.words[] | Text; mindestens 2; höchstens 15 | Ja |
| input.secretMessage | Text; höchstens 200 | Nein |
| options.seed | Zahl; Ganzzahl; mindestens 0; höchstens 2147483647 | Nein |
| options.hintMode | einer der Werte; none | first-letter | Nein |
| options.revealLetters | Liste; höchstens 26 | Nein |
| options.revealLetters[] | Text | Nein |
| options.showWordBank | wahr/falsch | Nein |
Vorlagen und Themen
Aktuelle Vorlagenkennungen, Themen und Kontogrenzen finden Sie unter /api/v1/capabilities. Auch eine Vorlage belegt einen Speicherplatz.
Bilder und Dateien
Bildeingaben verwenden eine zuvor hochgeladene oder importierte assetId desselben Kontos. Downloads erfolgen auf der Ergebnisseite im Browser; deren Link ist kein direkter Dateilink.
FehlerfÀlle
Unbekannte Felder oder widersprĂŒchliche Kombinationen aus type, mode und preset ergeben 422. Dasselbe gilt fĂŒr Eingaben, aus denen kein vollstĂ€ndiges RĂ€tsel entsteht. Formate hĂ€ngen von Konfiguration und Tarif ab.