APIのセットアップ
APIドキュメンテーション
以下に説明されているAPIセットアッププロセスを完了するために、Roktのアカウントマネージャーと連携してください。
APIドキュメンテーションには、以下の要件のいくつかまたはすべてが含まれる場合があります:
- エンドポイント
- メソッド
- ボディ
これは、Roktがどのようにリードをシステムに配信できるかを詳細に説明するものです。
APIドキュメンテーションと技術的な連絡先があれば、APIのセットアッププロセスを開始するのに十分です。
APIドキュメンテーションの良い例として、Mailchimp APIドキュメンテーションを参照してください。
技術的な連絡先の詳細
APIのセットアッププロセスに関する質問に対応できる、関連する連絡先（あなた自身またはチームの他の誰か）を提供してください。
技術的な連絡先は以下の点についてサポートできるはずです：
- システムにテストリードが正常に記録されているかの確認
- 応答ステータスが403である理由の説明
例：
John Smith
技術サポート
エンドポイント
ここはRoktがデータを配信する場所です。ステージングやテスト用のエンドポイントがある場合、RoktチームがセットアップとテストのプロセスでテストリードをライブCRMに配信しないようにするのに役立ちます。
例：
https://us9.api.mailchimp.com/3.0/lists/abcdefghij/members
メソッド
これはRoktがデータをリストに配信するために使用するHTTPリクエストの種類です。ほとんどの場合、これはPOSTリクエストです。
Roktは以下の送信方法をサポートしています：
- GET
- POST
- PUT
認証
RoktがAPIを呼び出すために必要な認証情報を提供してください。これは次のような形式で提供できます：
- ユーザー名とパスワードの組み合わせ
- APIキー
- クライアントIDとシークレット
APIパラメータ
Roktが各APIリクエストに含めるためのパラメータのリストを提供してください。可能であれば、次のようなものを指定してください：
- 必須の属性（リクエストが成功するために送信する必要がある属性）
- オプションの属性
- 各属性のパラメータ名（たとえば、
firstname、FirstName、またはfirst-nameのいずれを使用するか）
一般的な属性には次のものがあります：
- メール
- 名
- 姓
- ソース
- 国
参考のために、Roktはこれらの属性のいずれかを共有できます。
Roktは以下のボディエンコーディングをサポートしています：
- JSON
- URLエンコード
- プレーンテキスト
- XML
予想されるAPIのレスポンス
可能なAPIのレスポンスのリストを提供することで、Roktは成功したリードと、配信に失敗したか重複としてラベル付けされたリードを迅速に特定するためのレスポンス処理ロジックを設定できます。
レスポンス処理は、受け取ったステータスコードまたはレスポンスボディに基づいて作成することができます。これは、APIの設定方法によります。
例として、以下のステータスコードがあります：
- 201 (リードが正常に作成されました)
- 400 (認証されていません)
- 500 (サーバーエラー)
例として、以下のレスポンスボディの値があります：
"successfully delivered"{"status": "duplicate"}{"success": false}
Roktのパートナーとして、お客様がサイト上でRoktの配置物に関与するデータを受け取り、それを独自のCRMやレポートダッシュボードに統合することができるようにしたいと思うかもしれません。当社のデータ管理プラットフォームでは、トランザクションデータへのリアルタイムかつ安全なアクセスを提供することができます。トランザクションデータをAPI経由で直接CRMに統合することができる人気のあるオプションの一つです。
APIは、Roktがトランザクションデータを効率的にお客様に配信する最も効果的な方法です。これはリアルタイムで動作するため、お客様がサイト上の配置物に関与するとすぐに、Roktシステムがそのイベントをお客様のシステムに通知できます。以下に、これを完了するために必要ないくつかの技術的な要素を示します。