Bricsys 24/7 APIへのアクセスにはOAuth認証を使用します

概要

セキュリティを強化し、プラットフォームへのシームレスなアクセスを確保するには、すべての外部アプリケーションで OAuth を使用して認証する必要があります。

アプリケーションがシステムとどのようにやり取りするかに応じて、次のいずれかの OAuth フローを使用する必要があります。

  • 認証コードフロー: ユーザーが自分のデータにアクセスするためにログインする必要がある場合。
  • クライアント資格情報フロー: ユーザーの介入なしにアプリケーションが独立して動作する場合。

このガイドでは、OAuth への移行方法と、アプリケーションを当社の ID プロバイダーに登録するために必要な情報を説明します。

認証コード フローの使用（ユーザーベースのアクセスの場合）

アプリケーションでユーザーが認証して自分のデータにアクセスする必要がある場合は、承認コード フローを実装する必要があります。

実装手順
  1. 認証コードを要求するために、ユーザーを認証サーバーにリダイレクトします。
  2. ユーザーは資格情報を使用して認証します。
  3. アプリケーションは認証コードをアクセス トークンと交換します。
  4. アクセス トークンは、ユーザーに代わって API にアクセスするために使用されます。

以下も参照認可コードフロードキュメント。

OAuthクライアント登録に必要な情報
アプリケーションを登録するには、次の詳細を入力してください。
  • アプリケーション名: アプリを識別するための一意の名前を追加します。
  • 説明: アプリケーションでの Bricsys 24/7 API の使用法についての説明を追加します。
  • 技術連絡担当者: 名前とメール アドレスを追加します。
  • リダイレクト URI : 承認応答が送信される URL を追加します。

クライアント資格情報フローの使用（マシン間アクセスの場合）

アプリケーションがユーザー認証を必要とせず、独自に動作する場合 (バックグラウンド サービス、自動スクリプトなど) は、クライアント資格情報フローを使用します。

実装手順
  1. アプリケーションは、クライアント資格情報を使用して、承認サーバーから直接アクセス トークンを要求します。
  2. 認証が成功すると、アクセス トークンが返されます。
  3. アクセス トークンは、API と対話するために使用されます。

以下も参照クライアント資格情報フロードキュメント。

OAuthクライアント登録に必要な情報
アプリケーションを登録するには、次の詳細を入力してください。
  • アプリケーション名: アプリを識別するための一意の名前を追加します。
  • 説明: アプリケーションでの Bricsys 24/7 API の使用法についての説明を追加します。
  • 技術連絡担当者: 名前とメール アドレスを追加します。
  • サービス アカウント名: サービス アカウントとして使用する予定の Bricsys 24/7 アカウントの電子メール アドレスを追加します。
    注: このアカウントを使用してログインすることはできません。

一般的なOAuthリソース

OAuth とその実装について詳しくは、次のリソースを参照してください。

次のステップ

  1. アプリケーションのニーズに応じて適切な OAuth フローを選択します。
  2. 必要な登録詳細を収集します。
  3. サポートチームへのお問い合わせはサポートリクエスト申請の詳細を送信します。
  4. アプリケーションに認証フローを実装します。

さらにサポートが必要な場合は、 サポートリクエストの中でブリクシス24/7 > APIと統合カテゴリーまたは直接お問い合わせくださいsales@bricsys247.com 。私たちがお手伝いします!