URL構文

RayBarcodeのWeb API(REST API)を使ってSalesforceでバーコード画像を生成するためのURL構文を説明します。次のURLに続けて幅や高さ、値などのパラメータを指定します。

PNG形式の場合

https://gcbarcode.azurewebsites.net/api/png/[BarcodeType]?

SVG形式の場合

https://gcbarcode.azurewebsites.net/api/svg/[BarcodeType]?

[BarcodeType]には生成するバーコードのタイプを指定します。使用可能なバーコードの種類は「バーコードの種類」を参照してください。たとえばQRコードの場合、次のようになります。

https://gcbarcode.azurewebsites.net/api/png/qrcode?

URLの「?」以降にはパラメータを指定します。指定するパラメータは以下の通りです。以下の表のチェックマーク(✔)は必須であることを示します。

パラメータ 必須 説明
height バーコード画像の高さをピクセル単位で指定します。実際に生成されるバーコードの画像の高さは、指定したバーコードの規格に基づいてheightに近い値に決定されます。
width バーコード画像の幅をピクセル単位で指定します。実際に生成されるバーコードの画像の幅は、指定したバーコードの規格に基づいてwidthに近い値に決定されます。
token 認証に使用するアクセストークンを指定します。カスタム設定のgcbc__GcBarcodeSetting__c.gcbc__AccessToken__cを指定します。アンダースコアが2つずつ続いている点に注意してください。
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

RayBarcodeではURLの長さの上限の規定を設けていません。URLの長さの上限は、ユーザが呼び出しに使用するブラウザの仕様に依存します。Internet ExplorerやMicrosoft Edgeの場合、Google Chromeよりも短い長さで上限に達する場合がある点に留意してください。

参照:Internet Explorer では URL に最大 2,083 文字が使用可能 (Microsoft)

Copyright © 2020 GrapeCity inc. All rights reserved.