ビンゴカード API 資料

ビンゴカード: この資料のモード、ページ設定、出力形式、項目は API と共通の登録情報と入力規則から取得しています。

リクエスト例

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 } }'

モード

classic · signature · number · blank

ページ別の設定

ブラウザーでの出力形式

pdf · caller-pdf

出力形式はパズルの設定と契約で決まります。viewUrl と exportPageUrl はブラウザーでのダウンロード先です。応答に PDF、PNG、STL のファイル本体は含まれません。出力権限は公開時に確定し、再公開時に確認し直します。

共通の入力項目

項目	指定できる値	必須
preset	文字列	いいえ
mode	文字列	いいえ
locale	いずれか; en \| zh \| es \| de \| fr \| pt \| it \| id \| ja \| ko	いいえ
contentLanguage	いずれか; en \| zh \| es \| de \| fr \| pt \| it \| id \| ja \| ko	いいえ
title	文字列	はい
retentionDays	数値; 整数	いいえ
appearance.themeColor	文字列	いいえ
appearance.title.fontFamily	いずれか; sans \| serif \| handwriting \| playful \| mono	いいえ
appearance.title.fontWeight	いずれか; normal \| medium \| semibold \| bold \| extrabold	いいえ
appearance.title.color	文字列	いいえ
appearance.title.align	いずれか; left \| center \| right	いいえ
appearance.title.maxFontSize	数値; 最小 6; 最大 120	いいえ
appearance.grid.shape	いずれか; square \| circle	いいえ
appearance.grid.corners	いずれか; sharp \| sm \| md \| lg	いいえ
appearance.grid.gap	いずれか; none \| sm \| md \| lg	いいえ
appearance.grid.colorMode	いずれか; mono \| checker	いいえ
appearance.grid.bg	いずれか; 文字列 \| transparent \| object	いいえ
appearance.grid.textFontFamily	いずれか; sans \| serif \| handwriting \| playful \| mono	いいえ
appearance.grid.textFontWeight	いずれか; normal \| medium \| semibold \| bold \| extrabold	いいえ
appearance.grid.textColor	文字列	いいえ
appearance.grid.borderWidth	数値; 整数; 最小 0; 最大 3	いいえ
appearance.grid.borderColor	文字列	いいえ
appearance.grid.borderStyle	いずれか; solid \| dashed \| dotted	いいえ
appearance.card.bgColor	いずれか; 文字列 \| transparent \| object	いいえ
appearance.card.borderRadius	いずれか; sharp \| rounded	いいえ
appearance.card.borderWidth	数値; 整数; 最小 0; 最大 3	いいえ
appearance.card.borderColor	文字列	いいえ
appearance.header.bgColor	いずれか; 文字列 \| transparent \| object	いいえ
appearance.header.fontFamily	いずれか; sans \| serif \| handwriting \| playful \| mono	いいえ
appearance.header.fontWeight	いずれか; normal \| medium \| semibold \| bold \| extrabold	いいえ
appearance.header.color	文字列	いいえ
appearance.header.maxFontSize	数値; 最小 6; 最大 120	いいえ
appearance.footer.enabled	真偽値	いいえ
appearance.footer.text	文字列; 最大 200	いいえ
appearance.footer.fontFamily	いずれか; sans \| serif \| handwriting \| playful \| mono	いいえ
appearance.footer.fontWeight	いずれか; normal \| medium \| semibold \| bold \| extrabold	いいえ
appearance.footer.color	文字列	いいえ
appearance.footer.align	いずれか; left \| center \| right	いいえ
appearance.footer.maxFontSize	数値; 最小 6; 最大 120	いいえ
appearance.columnHeaders	配列; 最大 5	いいえ
appearance.columnHeaders[]	文字列; 最小 1; 最大 8	いいえ
appearance.showColumnHeaders	真偽値	いいえ
appearance.randomization	いずれか; full \| column	いいえ
appearance.freeSpaceLabel	文字列; 最大 40	いいえ
appearance.signatureLines	真偽値	いいえ
appearance.fontFamily	いずれか; sans \| serif \| handwriting \| playful \| mono	いいえ
appearance.fontSize	いずれか; small \| medium \| large	いいえ
appearance.headerBgColor	文字列	いいえ
appearance.showGridLines	真偽値	いいえ
appearance.outerBorder	真偽値	いいえ
appearance.borderStyle	いずれか; solid \| dashed \| dotted	いいえ
export.paperSize	いずれか; A3 \| A4 \| A4-landscape \| A5 \| B5 \| Letter \| Letter-landscape \| Legal \| Half-Letter \| Tabloid \| custom	いいえ
export.widthMm	数値; 最小 50; 最大 2000	いいえ
export.heightMm	数値; 最小 50; 最大 2000	いいえ
export.unit	いずれか; mm \| cm \| in \| px	いいえ
export.quality	いずれか; standard \| high \| print	いいえ
export.layout	いずれか; 1x1 \| 1x2 \| 2x2 \| 2x4	いいえ
input.words	配列; 最小 1; 最大 200	いいえ
input.words[]	文字列; 最小 1; 最大 50	いいえ
input.numbers	配列	いいえ
input.numbers[]	数値; 整数; 最小 0; 最大 9999	いいえ
options.seed	数値; 整数; 最小 0; 最大 2147483647	いいえ
options.gridSize	いずれか; 3 \| 4 \| 5	いいえ
options.cardCount	数値; 整数; 最小 1; 最大 100	いいえ
options.freeSpace	真偽値	いいえ
options.minNumber	数値; 整数; 最小 0; 最大 9999	いいえ
options.maxNumber	数値; 整数; 最小 0; 最大 9999	いいえ
options.ballCount	いずれか; 30 \| 75 \| 80	いいえ
options.signatureLine	真偽値	いいえ

テンプレートとテーマ

利用可能なテンプレート番号、テーマ、アカウントの制限は /api/v1/capabilities で確認してください。テンプレートを使った結果も保存枠を一つ使います。

画像とファイル

画像には、同じアカウントで事前に送信または取り込んだ assetId を指定します。ダウンロードはブラウザーの結果ページから行います。結果ページの URL はファイルへの直接リンクではありません。

失敗する場合

未知の項目や type、mode、preset の矛盾は 422 です。完成できない入力も 422 です。出力形式は設定とアカウントの権限で変わります。