ADO.NET Provider for Bullhorn CRM

Build 24.0.9062

接続の確立

接続前の要件

他の多くのデータソースとは異なり、Bullhorn CRM ではユーザーが独自のカスタムOAuth アプリケーションを作成したり、CallbackURL を直接編集したりすることはできません。代わりに、 Bullhorn CRM に連絡して、OAuth アプリケーション認証情報(クライアントID とクライアントシークレット)の作成または変更をリクエストする必要があります。

Bullhorn CRM はまた、必要に応じて使用するCallbackURL を提供したり更新したりします。しかしながら、Bullhorn CRM からの新しいCallbackURL を待つのは時間がかかる可能性があるため、CallbackURL の代わりにOAuth verifier コードを使用しての接続を検討することをお勧めします。 一度Bullhorn CRM がOAuth 認証情報を提供したら、それを使用してアプリケーションを認証することができます。

Bullhorn CRM への接続

アカウントへの認証とアクセスには、ユーザー名とパスワードが必要です。次の手順に従い接続を確立します。

  1. アカウント認証情報を使用して、Bullhorn CRM アカウントにログインします。
  2. アプリケーション設定のDataCenterCode をデータセンターに対応するデータセンターコードに設定します。データセンターコードの一覧は、こちらのリストを参照してください。

注記

  • データセンターコードが不明な場合は、CLS2、CLS21 などのコードは、ログイン後にブラウザのアドレスバーに表示されるURL に含まれるクラスタID であることに注意してください。例えば、 https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp?#no-ba... は、ログインユーザーがデータセンターCLS21 に関連付けられていることを示します。
  • もしhttp://localhost:33333/ のようなCallbackURL を指定する場合は、アプリケーション設定で指定したものと全く同じであることを確認してください。これには末尾のスラッシュ("/")も含まれます。 このURL から文字を追加または削除するとエラーになります。

Bullhorn CRM への認証(OAuth)

Bullhorn CRM はOAuth 認証のみサポートします。他の多くのデータソースとは異なり、Bullhorn CRM ではユーザーが独自のカスタムOAuth アプリケーションを作成したり、CallbackURL を直接編集したりすることはできません。 代わりに、カスタムOAuth アプリケーションの設定をBullhorn CRM にリクエストする必要があります。Bullhorn CRM サポートに連絡して設定プロセスを開始します。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。

以下のサブセクションでは、3つの一般的な認証フローでのBullhorn CRM への認証について詳しく説明します。

Bullhorn CRM で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

デスクトップアプリケーション

デスクトップアプリケーションを認証するには、verifier コードまたはカスタムCallbackURL のいずれかのオプションを使用します。カスタムCallbackURL を使用する方法は単純ですが、変更をリクエストするためにBullhorn CRM に直接連絡する必要があり、時間がかかる場合があります。 そのため、代わりにverifier コードを使用することを強く推奨します。セットアップの手間は若干増えるものの、認証プロセスは効率化されます。

オプション1:verifier コードの使用

verifier コードで認証プロセスを開始するには、認可URL を作成します。このURLは、アウトプットが一意のコードを生成するOAuth プロセスのトリガーとなるもので、アプリケーションとBullhorn CRM 間のセキュアなやりとりを可能にするアクセストークンを取得するために不可欠です。

OAuth verifier コードの取得

  1. 認可URL を次のように構成します。 https://<authorization URL for your data center>/oauth/authorize?client_id=<your OAuth Client Id>&response_type=code
    • 例えば、データセンターが"CLS40" である場合、認証に使用されるURL はhttps://auth-east.bullhornstaffing.com/oauth/authorize?client_id=<your OAuth Client Id>&response_type=code となります。
    • こちらのリストを参照して、データセンターコードに固有の認可URL を見つけます。
  2. 次に、認可URL をブラウザで開きます。
  3. ログインして、本製品 にアクセス許可を与えます。verifier コードを含むCallbackURL にリダイレクトされます。URL の形式は次のとおりです: https://www.bullhorn.com/?code=<verifiercode>&client_id=<clientid>
  4. verifier コードの値をURL から直接保存します。

OAuth アクセストークンの取得およびリフレッシュ

OAuth verifier コードを取得したら、次の手順ではそのコードを使用してOAuth アクセストークンを取得および管理します。このトークンによりお使いのアプリケーションは認証され、Bullhorn CRM とセキュアにやりとりすることができます。次の設定を行います。

  • OAuthVerifier:OAuth verifier コード。
  • DataCenterCode:アカウントが接続されているデータセンター。こちらからデータセンターのリストを探してください。
  • OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
  • CallbackURL:カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI。
  • InitiateOAuthGETANDREFRESHOAuthAccessToken を自動的に取得およびリフレッシュするために使用します。

本製品 は、アクセストークンを使用してリクエストを認証し、必要に応じてアクセストークンを更新し、OAuth 設定をOAuthSettingsLocation に永続的に保存することで、OAuth プロセスを処理します。

オプション2:カスタムCallbackURL の使用

CallbackURL(例:http://localhost:33333)の使用を希望する場合は、Bullhorn CRM に連絡して選択したURL をOAuth コールバックの認可エンドポイントとして設定するよう依頼してください。 Bullhorn CRM で使用するCallbackURLが準備されたことを確認したら、以下の設定を行いアプリケーションの設定を進めます。

  • CallbackURL:Bullhorn CRM に提供されたカスタムCallbackURL
  • DataCenterCode:アカウントが接続されているデータセンター。こちらからデータセンターのリストを探してください。
  • OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
  • InitiateOAuthGETANDREFRESHOAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
本製品 は、アクセストークンを使用してリクエストを認証し、必要に応じてアクセストークンを更新し、OAuth 設定をOAuthSettingsLocation に永続的に保存することで、OAuth プロセスを処理します。

Web アプリケーション

Web 経由で認証する場合は、カスタムOAuth アプリケーションの作成 で説明するようにBullhorn CRM にカスタムOAuth アプリケーションを作成および登録する必要があります。Bullhorn CRM に接続するWeb アプリケーションには、事前に定義および登録されたCallbackURL が必要です。このURL は、Bullhorn CRM が認証に成功した後にユーザーをリダイレクトする場所です。それから本製品 を使用してOAuth トークンの値を取得および管理します。

このセクションでは、OAuth アクセストークンの取得方法、ドライバーにOAuth アクセストークンを自動的に更新させる方法、OAuth アクセストークンを手動で更新する方法について説明します。

OAuth アクセストークンの取得

  1. OAuthAccessToken を取得するには、次の接続プロパティを設定します。
    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。
  2. ストアドプロシージャを呼び出し、OAuth 交換を完了します。
    • GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL をカスタムOAuth アプリケーション設定で指定したリダイレクトURI に設定します。 ストアドプロシージャがOAuth エンドポイントのURL を返します。
    • ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。コールバックURL にリダイレクトされます。
    • GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列のcode パラメータに設定します。

OAuth アクセストークンの自動リフレッシュ

本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには:

  1. はじめてデータに接続する前に、次の接続パラメータを設定します。
    • InitiateOAuthREFRESH
    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。
    • OAuthAccessTokenGetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation:本製品 がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。
    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。
  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンに置かれているリソースにログインする必要がある場合は、インターネットブラウザに対応した別の端末で認証する必要があります。以下のいずれかの方法で行います。

  • オプション1:OAuthVerifier コードを取得します。
  • オプション2:インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

オプション1:Verifier コードを取得および交換

Verifier コードを取得するには、次のようにOAuth Authorization URL で認証する必要があります。

  1. インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

    次のプロパティを設定します。

    • InitiateOAuthOFF
    • OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
    • DataCenterCode:アカウントが接続されているデータセンター。こちらからデータセンターのリストを探してください。

  2. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャは、カスタムOAuth アプリケーションが登録されたときに構築されたCallbackURL を返します。( カスタムOAuth アプリケーションの作成 を参照してください。)このURL をコピーして、新しいブラウザのタブに貼り付けます。
  3. ログインして、本製品 にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。
  4. GetOAuthAccessToken ストアドプロシージャを呼び出し、REST URL を保存します。これをRestUrl プロパティに設定します。
  5. OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

    ヘッドレスマシンでは、OAuth 認証値を取得するには次のプロパティを設定します。

    • InitiateOAuthREFRESH
    • OAuthVerifier:控えておいたverifier code(リダイレクトURI のcode パラメータの値)。
    • OAuthSettingsLocation:暗号化されたOAuth 認証値を指定されたファイルに永続化。
    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。
    • RestUrlGetOAuthAccessToken ストアドプロシージャによって返されたURL。
    • DataCenterCode:アカウントが接続されているデータセンター。こちらからデータセンターのリストを探してください。

  6. 接続をテストしてOAuth 設定ファイルを生成します。
  7. これらのプロパティを再設定すると、接続の準備が整います。
    • InitiateOAuthREFRESH
    • OAuthSettingsLocation:暗号化されたOAuth 認証値を含むファイル。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。
    • OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
    • RestUrlGetOAuthAccessToken ストアドプロシージャによって返されたURL。
    • DataCenterCode:アカウントが接続されているデータセンター。こちらからデータセンターのリストを探してください。

オプション2:OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンでデータに接続するには、次の接続プロパティを設定します。

  • InitiateOAuthREFRESH
  • OAuthSettingsLocation:ブラウザでマシンからコピーしたOAuth 設定ファイルへのパス。アクセストークンの自動リフレッシュを有効にするために、このファイルが に読み書きのアクセス許可を与えることを確認してください。
  • OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
  • RestUrlGetOAuthAccessToken ストアドプロシージャによって返されたURL。
  • DataCenterCode:アカウントが接続されているデータセンター。こちらからデータセンターのリストを探してください。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062