Pardot APIを使用する事になったのでAPI送信方法のメモ。
バージョン
APIのバージョンは、3と4が稼働中のよう。
使い分けは以下との事。
同じメールアドレスで複数のプロスペクトを作成できないアカウントの場合、バージョン 3 を参照してください。
同じメールアドレスで複数のプロスペクトを作成できるアカウントの場合、バージョン 4 を参照してください。
Pardot API を使用する場合
Authentication
http://developer.pardot.com/#authentication
送信パラメータは、ログイン用の email と password と、そのユーザの user_key 。
user_key は、 設定画面の MY PROFILEから確認出来る。
curlから送信した内容は以下。
1
2
3
4
5
6
| $ curl --request POST \
--url https://pi.pardot.com/api/login/version/4 \
--header 'content-type: multipart/form-data' \
--form 'email=test@example.com' \
--form 'password=your_password' \
--form user_key=your_user_key
|
レスポンスは以下のようにXMLで返ってくる。
1
2
3
4
5
| <?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok" version="1.0">
<api_key>you_api_key_here</api_key>
<version>4</version>
</rsp>
|
Create
http://developer.pardot.com/kb/api-version-4/prospects/#creating-prospects
Prospectを作成するには以下のエンドポイントにPOSTで送信する。
(APIの送信は認証も含めて全てPOSTで送信するよう。)
1
| POST : /api/prospect/version/4/do/create/email/
|
パラメータの必須項目は以下。
email : 作成するプロスペクトのメールアドレスapi_key : 認証で取得したキーuser_key : ユーザのキー
emailはパラメータにつけずに、エンドポイントの最後につけてしまってもよいよう。
1
| /api/prospect/version/4/do/create/email/<email>
|
curlで送信した内容は以下。
1
2
3
4
5
6
| curl --request POST \
--url https://pi.pardot.com/api/prospect/version/4/do/create/email/ \
--header 'content-type: multipart/form-data' \
--form api_key=your_api_key \
--form user_key=your_user_key \
--form email=create_email@example.com
|
返却されるXMLは以下。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
| <?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok" version="1.0">
<prospect>
<id>xxxxxxxx</id>
<campaign_id>xxx</campaign_id>
<salutation/>
<first_name/>
<last_name/>
<email>create_email@example.com</email>
<password/>
<company/>
<website/>
<job_title/>
<department/>
<country/>
<address_one/>
<address_two/>
<city/>
<state/>
<territory/>
<zip/>
<phone/>
<fax/>
<source/>
<annual_revenue/>
<employees/>
<industry/>
<years_in_business/>
<comments/>
<notes/>
<score>0</score>
<grade/>
<last_activity_at/>
<recent_interaction>Never active</recent_interaction>
<crm_lead_fid/>
<crm_contact_fid/>
<crm_owner_fid/>
<crm_account_fid/>
<salesforce_fid/>
<crm_last_sync/>
<crm_url/>
<is_do_not_email></is_do_not_email>
<is_do_not_call></is_do_not_call>
<opted_out></opted_out>
<is_reviewed></is_reviewed>
<is_starred></is_starred>
<created_at>2017-07-31 18:49:34</created_at>
<updated_at>2017-07-31 18:49:34</updated_at>
<campaign>
<id>xxx</id>
<name>Website Tracking</name>
</campaign>
<profile>
<id>xxx</id>
<name>Default</name>
<profile_criteria>
<id>xxx</id>
<name>Company Size</name>
<matches>Unknown</matches>
</profile_criteria>
<profile_criteria>
<id>xxx</id>
<name>Industry</name>
<matches>Unknown</matches>
</profile_criteria>
<profile_criteria>
<id>xxx</id>
<name>Location</name>
<matches>Unknown</matches>
</profile_criteria>
<profile_criteria>
<id>xxx</id>
<name>Job Title</name>
<matches>Unknown</matches>
</profile_criteria>
<profile_criteria>
<id>xxx</id>
<name>Department</name>
<matches>Unknown</matches>
</profile_criteria>
</profile>
<visitors/>
<visitor_activities/>
<lists/>
</prospect>
</rsp>
|
環境によってフィールドとかの増減があるのかも。
作成されたプロスペクトは、IDからURLでアクセス出来る。
https://pi.pardot.com/prospect/read/id/xxxxxxxx
Prospectの全標準項目は、以下のよう。
http://developer.pardot.com/kb/object-field-references/#prospect
