BasicQR APIガイド
BasicQRは、URLパラメータを使用してQRコードを生成するシンプルなAPIです。
デザイナーや開発者の方々が手軽に利用できるよう、以下に各パラメータの仕様と使用方法を詳しく説明します。
ご利用上の注意
- APIは一時的なテスト用を想定しており、本番環境での使用はお控えください。
- 作成されたQRコードは必ずテストしてください。
- アクセスが過度に集中した場合、サービスの利用を制限させていただくことがあります。
1. パラメータ一覧と省略形
| パラメータ名 | 省略形 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
text |
t |
必須 | なし | QRコードに変換する文字列 |
color |
c |
任意 | 000000 |
QRコードの色（16進数カラーコードまたは色名） |
backgroundColor |
b |
任意 | 00000000 |
QRコードの背景色（16進数カラーコードまたは色名） |
size |
s |
任意 | s |
QRコードのサイズ（s, m, l） |
filename |
f |
任意 | BasicQR |
ダウンロード時のファイル名（拡張子不要、最大50文字） |
2. 基本的なQRコードの生成
エンドポイント
GET https://basicqr.net/api/?text=<文字列>パラメータ
| パラメータ名 | 省略形 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
text |
t |
必須 | なし | QRコードに変換する文字列。URLエンコードが必要な場合があります。 |
使用例
GET https://basicqr.net/api/?text=HelloWorld上記のエンドポイントにアクセスすると、"HelloWorld"という文字列を含む基本的なQRコードが生成されます。
注意事項
textパラメータは必須です。未指定の場合、エラーとなります。- 文字列にスペースや特殊文字が含まれる場合、適切にURLエンコードしてください。
例：text=Hello%20World%21（"Hello World!"） - QRコードに埋め込むデータ量が多いと、コードの複雑性が増し読み取りにくくなる可能性があります。
- 基本的な生成方法では、他のパラメータを指定せずにシンプルなQRコードを作成します。
3. QRコードの色指定
エンドポイント
GET https://basicqr.net/api/?color=<カラーコードまたは色名>&text=<文字列>追加パラメータ
| パラメータ名 | 省略形 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
color |
c |
任意 | 000000（黒） |
QRコードの色を指定します。16進数カラーコードまたは色名で設定できます。 使用可能な色名はこちらの色の一覧をご覧ください。 |
使用例
GET https://basicqr.net/api/?color=blue&text=HelloWorld注意事項
colorの値は6桁または8桁の16進数カラーコード、または色名で指定してください。- 色名を指定する場合、大文字・小文字は区別されません。例：
Red、red、REDは同じ色として扱われます。 - 使用可能な色名は色の一覧ページをご確認ください。
4. QRコードの背景色指定
エンドポイント
GET https://basicqr.net/api/?backgroundColor=<カラーコードまたは色名>&text=<文字列>追加パラメータ
| パラメータ名 | 省略形 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
backgroundColor |
b |
任意 | 00000000（透明） |
QRコードの背景色を指定します。16進数カラーコードまたは色名で設定できます。 使用可能な色名はこちらの色の一覧をご覧ください。 |
使用例
GET https://basicqr.net/api/?backgroundColor=red&text=HelloWorld注意事項
backgroundColorの値は6桁または8桁の16進数カラーコード、または色名で指定してください。- 色名を指定する場合、大文字・小文字は区別されません。例：
Red、red、REDは同じ色として扱われます。 - 使用可能な色名は色の一覧ページをご確認ください。
5. QRコードのサイズ指定
エンドポイント
GET https://basicqr.net/api/?size=<サイズ>&text=<文字列>追加パラメータ
| パラメータ名 | 省略形 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
size |
s |
任意 | s |
QRコードのサイズを指定します。 有効な値：
|
使用例
GET https://basicqr.net/api/?size=m&text=HelloWorld6. QRコードのファイル名指定
エンドポイント
GET https://basicqr.net/api/?filename=<ファイル名>&text=<文字列>追加パラメータ
| パラメータ名 | 省略形 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
filename |
f |
任意 | BasicQR |
ダウンロード時のファイル名を指定します。拡張子は不要です。 名称の長さは最大50文字までです。 |
使用例
GET https://basicqr.net/api/?filename=MyQRCode&text=HelloWorld7. 複数のパラメータの同時指定
エンドポイント
GET https://basicqr.net/api/?size=<サイズ>&color=<カラーコード>&backgroundColor=<カラーコード>&filename=<ファイル名>&text=<文字列>使用例
GET https://basicqr.net/api/?size=l&color=00ff00&backgroundColor=ffffff&filename=CustomQR&text=HelloWorld8. 注意事項
- パラメータの値は、必要に応じてURLエンコードを行ってください。ただし、エンコードは必須ではありません。
- 重要：
textパラメータにエンコードされていないURLを指定する場合、他のパラメータはtextの前に記載してください。そうしないと、これらのパラメータがtextの一部として解釈され、正常に動作しない可能性があります。 - パラメータ名は、省略形を使用することができます。例：
textはt、backgroundColorはbと指定可能です。 - パラメータ名と省略形が同時に指定された場合、パラメータ名が優先されます。
9. エラーハンドリング
不正なパラメータや値が指定された場合、HTTPステータスコード 404 Not Found が返されます。
例：text パラメータが未指定の場合
HTTP/1.1 404 Not Found