ForHosting KIT · 開発者向けツール

QRコード用vCard文字列を作成

氏名、電話番号、メールアドレス、組織名を、QRコード向けのvCard 3.0ペイロードへ変換します。必須のvCard区切り、適切なエスケープ、互換性の高い改行を備えた決定的な文字列を返します。QRエンコーダーへ貼り付けるか、自動処理の次工程へ渡していただけます。氏名のみ必須で、その他の項目は任意です。そのため、最小限の個人カードから詳しいビジネス連絡先まで、同じ処理で作成できます。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

QRコードを生成する前に連絡先データを整えます

連絡先用QRコードには、画像専用の連絡先形式ではなく、通常は構造化テキストが格納されます。この機能はそのテキスト層を作成します。BEGIN:VCARDで始まり、VERSION:3.0を宣言し、必須の表示名を含め、END:VCARDで終了するvCard 3.0ペイロードです。空でない氏名を指定し、必要に応じて電話番号、メールアドレス、組織名を追加してください。空の任意項目は出力されません。結果は対応するQRエンコーダーのテキスト入力として利用できます。内容作成と画像生成を分けることで、サイズ、誤り訂正、色、画像形式を決める前に、データを確認、保存、試験、再利用できます。問題の切り分けも容易です。スキャナーがvCardを認識しても印刷した記号を読めない場合は、QR描画側を確認できます。同じ入力からは常に同じ文字列が得られます。

エスケープ、改行、任意プロパティを確認します

vCardの値は自由なテキスト行ではありません。バックスラッシュ、コンマ、セミコロン、改行には構造上の意味があるため、そのまま連結すると連絡先が変わったり、アドレス帳ごとに解釈が異なったりします。この生成機能は各値の該当文字をエスケープし、vCardで期待されるCRLF改行を使用します。氏名や組織名の内部改行は、意図しない新規プロパティではなく、同じプロパティ内のエスケープ済み改行になります。氏名はFNとして記録します。電話、メール、組織は、外側の空白を除去した後に値がある場合だけTEL、EMAIL、ORGとして追加されます。内部の有意な文字は保持されます。END:VCARDの後にもCRLFを付け、通常の終端を求めるシステムにも対応します。これにより、小さく予測可能で、入力情報に忠実なペイロードになります。

自動処理とQRコードで確実にご利用いただけます

返されたpayloadフィールドを変更せず、QR生成器のテキスト内容として指定してください。再度JSONへシリアライズしたり、改行を目に見えるスラッシュ文字へ置き換えたりしないでください。QRコードには実際のvCardテキストを格納する必要があります。印刷や広範な配布の前に、複数のカメラや連絡先アプリで読み取りをお試しください。読取機器の挙動、印刷サイズ、コントラスト、QR誤り訂正は本機能の範囲外ですが、最終的な使いやすさに影響します。自動処理では元の構造化項目も保存し、変更時に符号化済み文字列を編集せず再生成できるようにしてください。厳密な業務規則が必要な場合、メールと電話の妥当性は事前に検証してください。成功したAPIリクエストの料金は$0.002です。空白だけの氏名には入力エラーを返します。

活用例

デジタル名刺を作成します

職業上の氏名と連絡先を、名刺用QRコードのテキスト層へ変換します。

イベント用名札で連絡先を共有します

参加者記録から統一されたvCardペイロードを作成し、個別のQRコードへ利用します。

職員名簿の素材を自動更新します

電話、メール、組織が変わるたびにQR対応の連絡先ペイロードを再作成します。

よくある質問

どのvCardバージョンを使用しますか？

VERSION:3.0を宣言し、FNと、指定されたTEL、EMAIL、ORGを含む簡潔なレコードを生成します。

電話、メール、組織を省略できますか？

はい。3項目はいずれも任意で、省略または空の場合は空のプロパティを作成しません。

なぜ氏名が必須なのですか？

連絡先を識別する表示名プロパティに使うためです。空または空白だけの値は入力エラーになります。

この処理でQR画像も生成されますか？

いいえ。別のQRコード生成器へ渡す、標準形式の文字列のみを返します。

コンマや改行は安全に処理されますか？

はい。各プロパティの組み立て前に、バックスラッシュ、コンマ、セミコロン、改行をエスケープします。

APIリクエストの料金はいくらですか？

成功したリクエストごとに$0.002です。同じ決定的な変換をブラウザーでも実行できます。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/enc/qr-vcard-payload

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/enc/qr-vcard-payload \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ada Lovelace"}'

const res = await fetch("https://api.kit.forhosting.com/enc/qr-vcard-payload", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "Ada Lovelace"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/enc/qr-vcard-payload",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "name": "Ada Lovelace"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/enc/qr-vcard-payload", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"name":"Ada Lovelace"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"name":"Ada Lovelace"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/enc/qr-vcard-payload", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "name": "Ada Lovelace"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "enc.qr_vcard_payload",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →