REST API
作成対象:
- 管理者
Marketo は、システムの多くの機能をリモートで実行できる REST API を公開しています。プログラムの作成からリードの一括読み込みまで、Marketo インスタンスの詳細な制御を可能にするオプションが多数あります。
一般に、これらの API は、リードデータベースとアセットという 2 つの大きなカテゴリに分類されます。Lead Database API を使用すると、Marketo のユーザレコードや、商談や会社などの関連オブジェクトタイプを取得および操作できます。Asset API を使用すると、マーケティングの販促物やワークフロー関連のレコードとのインタラクションが可能になります。
- 毎日の割り当て量: サブスクリプションには 1 日あたり 50,000 回の API 呼び出しが割り当てられます(毎日午前 12:00 CST にリセットされます)。アカウントマネージャーを通じて、毎日の割り当て量を増やすことができます。
- レートの制限: インスタンスあたりの API アクセスは、20 秒あたり 100 回の呼び出しに制限されます。
- 同時実行の制限: 同時 API 呼び出しは最大 10 回までです。
標準呼び出しのサイズは、URI の長さが 8 KB、本文のサイズが 1 MB に制限されていますが、一括 API の場合、本文は 10 MB まで可能です。呼び出しでエラーが発生した場合、API は通常、ステータスコード 200 を返しますが、JSON 応答には、値が false
の「success」メンバーと、「errors」メンバー内のエラーの配列が含まれます。エラーについて詳しくは、こちらを参照してください。
はじめに
次の手順では、Marketo インスタンスの管理者権限が必要です。
Marketo への最初の呼び出しでは、リードレコードを取得します。Marketo の操作を開始するには、インスタンスへの認証された呼び出しを行う API 資格情報を取得する必要があります。インスタンスにログインし、管理/ユーザ&ロール に移動します。
「ロール」タブをクリックし、「新規ロール」をクリックして、Access API グループのロールに少なくとも「読み取り専用リード」(または「読み取り専用ユーザ」)権限を割り当てます。わかりやすい名前を付けて、「作成」をクリックします。
次に、「ユーザ」タブに戻り、「新規ユーザを招待」をクリックします。ユーザに、API ユーザであることを示すわかりやすい名前とメールアドレスを指定して、「次へ」をクリックします。
次に、「API のみ」オプションをオンにして、作成した API ロールをユーザに付与し、「次へ」をクリックします。
ユーザ作成プロセスを完了するには、「送信」をクリックします。
次に、管理メニューに移動して、「Launchpoint」をクリックします。
新規 メニューをクリックして、「新規サービス」を選択します。サービスにわかりやすい名前を付け、サービスドロップダウンメニューから「カスタム」を選択します。説明を入力し、API のみのユーザドロップダウンメニューから新規ユーザを選択して、「作成」をクリックします。
新しいサービスの「詳細を表示」をクリックして、クライアント ID とクライアント秘密鍵にアクセスします。現時点では、「トークンを取得」ボタンをクリックして、1 時間有効なアクセストークンを生成できます。現時点では、トークンをメモに保存します。
次に、管理 メニューに移動し、Web サービス に移動します。
現時点では、「REST API」ボックスでエンドポイントを見つけて、メモに保存します。
REST API メソッドを呼び出す場合、呼び出しが成功するには、すべての呼び出しにアクセストークンを含める必要があります。アクセストークンは、HTTP ヘッダーとして送信する必要があります。
Authorization: Bearer cdf01657-110d-4155-99a7-f986b2ff13a0:int
新しいブラウザータブを開き、適切な情報を使用して、フィルタータイプによりリードを取得を呼び出します。
<Your Endpoint URL>/rest/v1/leads.json?&filterType=email&filterValues=<Your Email Address>
データベース内に自分のメールアドレスを含むリードレコードがない場合は、存在すると分かっているレコードで代用します。URL バーで Enter キーを押すと、次のような JSON 応答が返されます。
{
"requestId":"c493#1511ca2b184",
"result":[
{
"id":1,
"updatedAt":"2015-08-24T20:17:23Z",
"lastName":"Elkington",
"email":"developerfeedback@marketo.com",
"createdAt":"2013-02-19T23:17:04Z",
"firstName":"Kenneth"
}
],
"success":true
}
API 使用量
各 API ユーザは API 使用量レポートで個別に報告されるので、web サービスをユーザごとに分割すると、各統合の使用量を簡単に把握できます。インスタンスへの API 呼び出しの数が制限を超え、後続の呼び出しが失敗する場合は、この方法を使用すると、各サービスからのボリュームを把握し、問題を解決する方法を評価できます。使用量を確認するには、管理/統合/Web サービス に移動し、過去 7 日間の呼び出し回数をクリックします。