OutSystemsでセキュアなREST APIを作成する方法

目次

  1. ベーシック認証
  2. カスタム認証
  3. 詳細

REST APIを公開する際、サービスに設定を行うことで認証を必須にできます。認証モードは以下の3つから指定できます。

  • None(認証なし): 誰でも認証なしでAPIを呼び出せます。
  • Basic(ベーシック認証):REST APIを呼び出すには、リクエストのHTTPヘッダーでユーザー名とパスワードを指定する必要があります。
  • Custom(カスタム認証):独自の認証メカニズムを実装できます。

ベーシック認証


チームのREST APIでユーザー名/パスワード認証を要求するには、ベーシック認証を追加します。ビジュアルエディタでそのサービスにAuthenticationパラメータを設定すると、追加が完了します。

サービスにベーシック認証を設定すると、APIを使用するすべてのクライアントは、リクエストのHTTPヘッダーで資格情報を送信するよう要求されます。資格情報が存在しない場合、OutSystemsはJSONで以下のようなエラーメッセージを自動的に送信します。

{
  "Errors": [
    "Basic Authentication required."
  ],
  "StatusCode":401
}

クライアントが資格情報を送信すると、OutSystemsはそれらをパラメータとして利用できるようにします。これにより、認証の機能を実装するために必要となる定型コードの大半を自動化することができます。

カスタム認証


既存のフックを使用してカスタム認証ロジックを実装します。この場合、ビルトインのメソッドを使用して、クライアントが送信したHTTPヘッダーおよびボディをチェックできます。

または、独自のコードを使用して、ビルトインのメソッドを拡張することもできます。

詳細


詳細については、次のリンクをご覧ください。