カスタム認証情報

この例では、認証情報にセキュアに格納されているAPIキーをクエリ文字列としてリクエストURLに渡す方法を表しています。

認証情報を構成する

APIキーは、認証情報のパスワードフィールドに格納されています。

Web API定義を構成する

カスタム認証タイプは、API定義の［共通認証］画面で選択されます。認証情報はリクエストヘッダーで渡されないため、選択する必要はありません。代わりに、［プロセスに公開］を選択して、プロセスに必要な認証情報を決定する入力パラメーターを作成します。

リクエストのURLで、APIキーの代わりに[Credential.Password]を入力します。

これにより、与えられた認証情報のパスワードフィールドがパラメーター化され、値を渡すことができるようになります。同じ構文を使用して、認証情報から他の値を渡すことができます。

• [Credential.Password]
• [Credential.UserName]
• [Credential.AdditionalProperties<propertyname>]

オブジェクトまたはプロセス内の認証情報を指定する

必要なビジネスオブジェクトとアクションはプロセスアクションで選択されます。API定義に設定されたパラメーターは入力パラメーターとして利用できます。パラメーターの値は、引用符で囲まれた必要な認証情報の名前になります。

オブジェクトまたはプロセスが実行されると、認証情報からのAPIキーがリクエストで使用されます。

GET http://www.postcodeuk.com/address/UK/"Andy Taylor"?api_key=FGRS5-PUUDW-NBC2Q-96UYR-QBDSY