統合一意識別子の追加
Dotcom-Monitor との統合をセットアップするには、アクティブな Dotcom-Monitor アカウントにアクセスし、認証要求で使用する Web API 固有識別子を作成する必要があります。
- ドットコムモニターアカウントにログインします。
- ドットコムモニターで、統合の構成統合追加 Web API の下に統合 UID > > を作成 > します。
- ウィキの「Web APIアクセスのIPをホワイトリスト に登録する方法」の記事で説明されているように、IPをホワイトリスト に登録します。
- オプション: マスターアカウントに部門が含まれ、特定の部門の API にアクセスして要求を送信する場合は、[ 統合の追加 ] ウィンドウで [ 部門のデータへのアクセスを許可する] を選択します。
- [統合の作成] をクリックし、[統合UID]リストから[Web API一意識別子] をクリップボード (部門アクセスの場合は、部門のデータにアクセスできる Web API) にコピーします。
認証
URL をリクエストする
| 投稿 | https://api.dotcom-monitor.com/config_api_v1/login |
「/login」呼び出しを介してアカウントにログインすると、新しいクライアントセッションが開始されます。 セッションは、所定の長さの非アクティブ時間が経過すると自動的に期限切れになります。 デフォルトは 1 分です。 API 呼び出しを行うと、非アクティブタイマーはゼロにリセットされます。
セッションの有効期限が切れると、例外 HTTP エラー コード “401 – 許可されていません” が返されます。 この場合は、再度ログインする必要があります。
コンテンツの投稿
UIDパラメーター値として Web API 固有ID を使用する ( > 統合の構成 > 統合Web API の追加 > )。
{
"UID":"1423e214d153d123123"
}
部門 ID アクセス
APIを介して部門のデータにアクセスするには、 Web API(部門のデータにアクセスできる) 統合を作成する必要があります。 対応する 一意の識別子 を UID パラメーターとして、認証要求の ” Action” : 1 の名前と値のペアと組み合わせて使用します。
次の投稿コンテンツ サンプルを使用します。
{
"UID" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Action": 1
}
システムは、使用可能な部門 ID のリストで応答します。 以下の JSON の例を参照してください。
{
"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をコピーし、UIDと組み合わせて使用して、部門への認証要求を作成します。
以下に示す Post サンプルを使用します。
{
"UID" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
"Id" : "XXXX"
}
ここで ” UID”:”XXXXX….XXX 」はWeb API(部門のデータにアクセスできる) UID と「ID」です :「XXXX」 はあなたの部門IDです。
成功の応答
{
"Success":true,
"Result":"OK"
}