統合一意識別子の追加

Dotcom-Monitor との統合をセットアップするには、アクティブな Dotcom-Monitor アカウントにアクセスし、認証要求で使用する Web API 固有識別子を作成する必要があります。

  1. ドットコムモニターアカウントにログインします。
  2. ドットコムモニターで、統合の構成統合追加 Web API の下に統合 UID > > 作成 > します。
  3. オプション: マスターアカウントに部門が含まれ、特定の部門の API にアクセスして要求を送信する場合は、[ 統合の追加 ] ウィンドウで [ 部門のデータへのアクセスを許可する] を選択します。
  4. [統合の作成] をクリックし、[統合UID]リストから[Web API一意識別子] をクリップボード (部門アクセスの場合は、部門のデータにアクセスできる Web API) にコピーします。

認証

URL をリクエストする

投稿 https://api.dotcom-monitor.com/config_api_v1/login

「/login」呼び出しを介してアカウントにログインすると、新しいクライアントセッションが開始されます。 セッションは、所定の長さの非アクティブ時間が経過すると自動的に期限切れになります。 デフォルトは 1 分です。 API 呼び出しを行うと、非アクティブタイマーはゼロにリセットされます。
セッションの有効期限が切れると、例外 HTTP エラー コード “401 – 許可されていません” が返されます。 この場合は、再度ログインする必要があります。

承認後、クライアントはクッキーによって識別されるため、クッキーが有効になっていることを確認してください。

コンテンツの投稿

UID アクセス (推奨)

UIDパラメーター値として Web API 固有ID を使用する ( > 統合の構成 > 統合Web API の追加 > )。

{
"UID":"1423e214d153d123123"
}

部門 ID アクセス

API を介して部門のデータにアクセスするには 、Web API (部門のデータへのアクセス権) の 一意識別子を “UID” パラメーターとして使用し、次の Post コンテンツ サンプルを使用して認証要求を送信します。

{ 
"UID" : "4821737B71224A087641585F80BF8",
"Action": 1
}

この場合、システムは利用可能な部門 ID のリストを使用して応答します。

{
    "Success": true,
    "Result": [
        {
            "Name": "my_org",
            "HasCompany": true,
            "HasDepartment": true,
            "Qantity": 2,
            "Accounts": [
                {
                    "Id": 15530,
                    "Name": "my_org",
                    "CompanyName": "my company",
                    "Email": "email@gmail.com",
                    "Owner": true,
                    "Department": false,
                    "New": false
                },
                {
                    "Id": 19357,
                    "Name": "Admin",
                    "CompanyName": "my company",
                    "Email": "email111@gmail.com",
                    "Owner": true,
                    "Department": true,
                    "New": false
                }
            ]
        }
    ]
}

ログインする部門の ID をコピーし、Web API UID と組み合わせて使用して、部門への認証要求を作成します。 次のサンプルを使用します。

{ 
"UID" : "4821737B71B22A087641585F80BF8"
 "Id" : "19357"
}

従来のユーザー名とパスワード (推奨されません、アカウント ID が必要な場合があります)

{
"username":"username",
"password":"password"
}

成功の応答

{
"Success":true,
"Result":"OK"
}