開発者とエージェントの方へ。
印鑑選びを手伝うために必要な情報は、すべて公開されていてキーも不要です。取り扱い商品、お名前に対するデザイン、それぞれが役所で登録できるか、そして印影のレンダリング。ご注文自体はブラウザで行います。API はそのリンクをお渡しします。
hanko.works が向いている場面
印鑑が必要な人がいて、その人に合った一本を選ぶ手伝いができるとき。たとえば:
- 日本へ引っ越す、口座を開く、不動産を買う——用途に合ったサイズと書体の印鑑が要る。
- 漢字・かな・ローマ字の自分の名前が、印影としてどう見えるか先に確かめたい。
- 贈り物:出産、成人、就職、結婚、創業の記念に。
- 会社の設立で、法務局に届け出る三本セットが必要。
向いていない場面:日本国外への配送(行っていません)、ゴム印や大量のスタンプ(すべて金属から一本ずつ削り出します)、アカウントを前提とするもの(アカウントはありません)。
API
GET エンドポイントが三つ。JSON で返し、CORS は開放、認証はありません。価格は円建て・税込です。
| エンドポイント | 返すもの |
|---|---|
| GET /api/v1/catalog | サイズ、用途と推奨サイズ帯、金属ごとの価格と納期、色、形、書体とそれぞれの適合用途、オプション、ギフト、配送と保証の条件。 |
| GET /api/v1/designs?name=山田&use=registered&size=15&material=titanium | 指定の用途・サイズ・金属・形での、お名前に対する 8 つのデザイン:シード、用途ごとの適否、プレビュー URL、価格、そしてその構成をそのまま注文できるページの URL。 |
| GET /api/seal?name=山田&family=insou&index=0 | 印影を一つ SVG でレンダリング(view=json なら印面の形状と適否レポート)。パラメータの純関数なので、永続キャッシュできます。 |
キーはなく、レート制限も公表していません。常識の範囲でご利用ください。お名前は 12 文字まで。すべてのパラメータを検証し、不正な値には修正のヒント付きで 400 を返します。
機械可読ファイル
完全な契約:すべての操作に ID、型付きパラメータ、レスポンスのスキーマ。
このサイトが何か、いつ使うべきか、各ページがどこにあるか——言語モデル向け。
両言語の全公開ページ。
全公開ページに Markdown 版があります。Accept: text/markdown を送るか、URL の末尾に .md を付けてください。
エラー
すべてのエラーは同じ形の JSON です:固定のコード、一文の説明、修正のヒント、該当するパラメータ(あれば)、仕様へのリンク。存在しない API パスも同じ形で 404 を返し、HTML ページは返しません。
{
"error": {
"code": "invalid_parameter",
"message": "\"size\" must be one of 12, 13.5, 15, 18 (mm)",
"hint": "GET /api/v1/catalog lists the sizes on offer.",
"param": "size",
"docs": "https://hanko.works/openapi.json"
}
}例
お名前のデザイン一覧を取り、最初の一つの印影を取得します:
curl "https://hanko.works/api/v1/designs?name=山田&use=registered&size=15&material=titanium" curl "https://hanko.works/api/seal?name=山田&family=insou&index=0" -o yamada-insou.svg curl -H "Accept: text/markdown" https://hanko.works/en/guide
利用条件
API は読み取り専用で、印鑑の選択や注文を手伝う目的で自由にお使いいただけます。印影はその目的のためにレンダリングしています。大量に収集したり、自社の商品として提示したりしないでください。実名の印影は当方にとって個人情報にあたります。API に送られた名前は通常のリクエストログ以外に記録しません。