RayBarcodeのWeb API（REST API）を使ってSalesforceでバーコード画像を生成するためのURL構文を説明します。
バーコード画像の形式（「PNG」または「SVG」）を指定します。
PNG形式の場合
png、Image APIを使用してバーコード画像を生成します。 Image APIを使う際は、パラメーター「outputformat」の値を”PNG”に指定する必要があります。
https://gcbarcode.azurewebsites.net/api/png/[BarcodeType]?
https://gcbarcode.azurewebsites.net/api/Image/[BarcodeType]?outputformat=PNG
SVG形式の場合
Image APIを使用してバーコード画像を生成します。
https://gcbarcode.azurewebsites.net/api/Image/[BarcodeType]?
[BarcodeType]には生成するバーコードのタイプを指定します。使用可能なバーコードの種類は「バーコードの種類」を参照してください。たとえばQRコードの場合、次のようになります。
https://gcbarcode.azurewebsites.net/api/[使用するAPI名]/qrcode?
URLの「?」以降にはパラメーターを指定します。使用するAPIによってパラメーター名に若干の違いがありますので、注意してください。以下の表のチェックマーク（✔）は必須であることを示します。
png APIの場合
| パラメーター | 必須 | 説明 |
|---|---|---|
| height | ✔ | バーコード画像の高さをピクセル単位で指定します。実際に生成されるバーコードの画像の高さは、指定したバーコードの規格に基づいてheightに近い値に決定されます。 |
| width | ✔ | バーコード画像の幅をピクセル単位で指定します。実際に生成されるバーコードの画像の幅は、指定したバーコードの規格に基づいてwidthに近い値に決定されます。 |
| token | ✔ | 認証に使用するアクセストークンを指定します。カスタム設定のgcbc__GcBarcodeSetting__c.gcbc__AccessToken__cを指定します。アンダースコアが２つずつ続いている点に注意してください。有効期限は15分です。 |
| value | ✔ | バーコードの値を指定します。指定する値はUTF-8形式でURLエンコードされている必要があります。たとえば「こんにちは」は「%e3%81%93%e3%82%93%e3%81%ab%e3%81%a1%e3%81%af」となり、「https://www.Salesforce.com 」は「https%3a%2f%2fwww%2eSalesforce%2ecom」となります。 |
| options | バーコードタイプ固有の追加オプションを指定します。「バーコードのオプション」を参照してください。 |
記述例は以下のようになります。
https://gcbarcode.azurewebsites.net/api/png/qrcode?width=300&height=300&value=This%20is%20sample%20Barcode&token=$Setup.gcbc__GcBarcodeSetting__c.gcbc__AccessToken__c
Image APIの場合
| パラメーター | 必須 | 説明 |
|---|---|---|
| imageHeight | ✔ | バーコード画像の高さをピクセル単位で指定します。実際に生成されるバーコードの画像の高さは、指定したバーコードの規格に基づいてimageHeightに近い値に決定されます。 |
| imageWidth | ✔ | バーコード画像の幅をピクセル単位で指定します。実際に生成されるバーコードの画像の幅は、指定したバーコードの規格に基づいてimageWidthに近い値に決定されます。 |
| token | ✔ | 認証に使用するアクセストークンを指定します。カスタム設定のgcbc__GcBarcodeSetting__c.gcbc__AccessToken__cを指定します。アンダースコアが２つずつ続いている点に注意してください。有効期限は24時間です。 |
| value | ✔ | バーコードの値を指定します。指定する値はUTF-8形式でURLエンコードされている必要があります。たとえば「こんにちは」は「%e3%81%93%e3%82%93%e3%81%ab%e3%81%a1%e3%81%af」となり、「https://www.Salesforce.com 」は「https%3a%2f%2fwww%2eSalesforce%2ecom」となります。 |
| outputformat | 条件によって必須 | バーコード画像の形式（「PNG」または「SVG」）を指定します。この値は大文字で指定します。Image APIを使ってPNGファイル形式のバーコード画像を生成する場合は、outputformatの指定が必須となります。 |
| options | バーコードタイプ固有の追加オプションを指定します。「バーコードのオプション」を参照してください。 |
記述例は以下のようになります。
https://gcbarcode.azurewebsites.net/api/Image/qrcode?imageWidth=300&imageHeight=300&value=This%20is%20sample%20Barcode&token=$Setup.gcbc__GcBarcodeSetting__c.gcbc__AccessToken__c
https://gcbarcode.azurewebsites.net/api/Image/qrcode?outputformat=PNG&imageWidth=300&imageHeight=300&value=This%20is%20sample%20Barcode&token=$Setup.gcbc__GcBarcodeSetting__c.gcbc__AccessToken__c
RayBarcodeではURLの長さの上限の規定を設けていません。URLの長さの上限は、ユーザーが呼び出しに使用するブラウザーの仕様に依存します。Internet ExplorerやMicrosoft Edgeの場合、Google Chromeよりも短い長さで上限に達する場合がある点に留意してください。