OutSystemsのConsume REST API（外部のREST APIをOutSystemsのActionのように扱えるようにする機能）はBasic Authenticationをプロパティ指定だけで設定できる。
ちょっと使い方がわかりにくいようなので、手順を確認しておく。
なお、テスト用のREST API（ConsumeするAPI）は、参考に示した過去の記事で作成した以下のExpose REST APIを使う。AuthenticationプロパティをBasicにするのがポイント。
環境情報
ODC Studio(Version 1.4.24)
参考
Expose REST APIのBasic Authenticationについては以下を参照。
Consume REST APIの公式ドキュメント（2024/09/20時点では日本語訳が無いようす）：
Consume REST APIs - ODC Documentation
Consume REST APIを定義
テスト用のAPIはOutSystemsで作成したExpose REST APIなので、swaggerファイルが自動生成される。
よって、このswaggerの定義を使ってConsume REST APIを定義する。
作成手順：
- ODC Studio上でREST APIを右クリック
- Open Documentationメニューを選択してswaggerドキュメントのページを開く
- ページ上にある「swagger json」リンクのアドレスをコピー
- ODC Studioに戻り、RESTを右クリック
- Consume REST API...を選択
- Add multiple methodsを選択
- コピーしておいたアドレスを貼り付けて「Add methods」ボタンをクリック
Consume REST APIが出来上がる。
Descriptionプロパティには、Basic認証が必要であることを示すコメントが入っているものの、Authenticationは「No authentication」。
認証が設定されていないので、このままREST API Methodを呼ぶと、当然認証エラーになる。
以下で、Basic認証を設定する方法を示す。
方法１：Basic authenticationプロパティを設定する（Stage毎に固定の認証情報）
こちらは設定のみで可能な方法。
まずは、REST APIを選択し、Authentication > TypeプロパティでBasic authenticationを選択する。
認証情報はODC PortalでStage毎に設定。
- ODC PortalでAppのページを開く
- Configurationタブ > Consumed REST APIsを展開し、作成したConsume REST APIのリンクをクリックして開く
- Consume REST APIの設定ページが開くので右上のEditボタンをクリック
- Basic authenticationのエリアで、ラジオボタンをCustomに変更し、使いたいBaisc認証用アカウント情報を設定し、Saveボタンをクリック
ただし、この情報は上の設定手順からもわかるように設定できる認証情報がStage・REST API毎で固定になる。
方法２：On Before Request Callbackでリクエストヘッダに設定する（実行時に動的に設定可能）
Authentication > typeはNo authenticationに戻す。Advanced > On Before RequestプロパティでNew OnBeforeRequestを選択し、Consume REST API Method実行時の前処理を作成する。
このOnBeforeRequst内でCustomizedRequestというOutput Parameterを編集することでHTTPリクエストを変更できる。
HTTPリクエストヘッダーにAuthorizationヘッダーを追加すれば良い。
Authorizationヘッダーの値のフォーマットは、
- 認証に使うUsernameとPasswordを「:」（半角コロン）で結合
- 1の結果をBASE64エンコーディングする
- 値は「Basic <2の結果>」
実装例（SettingsにUsernameとPasswordを設定しておく）
先頭のAssignは自動で設定されるものなのでそのまま触らずにおく。
実装内容は、Action FlowにつけたCommentの通り。
最後のListAppendは、以下のパラメータを設定。
用途の例としては、OnBeforeRequest内で、Request.URLPathなどを見て対象のMethodを特定し、Method毎に異なる認証情報を設定する、などが考えられる。