Pardot API客户端
pardot-api-client的Python项目详细描述
pardot api的python客户端。
它提供了对象表示法,用于以简洁的惯用语句(如:
>>>client.prospect.read('someone@example.com')>>>client.prospect.update('someone@example.com',first_name='John')
功能
- 支持Python2和3
- 支持API版本3
- 支持所有API实体:帐户、活动、自定义域、自定义重定向、动态内容、电子邮件、电子邮件单击、表单、标识的公司、生命周期历史记录、生命周期阶段、列表、列表成员资格、机会、配置文件、配置文件条件、前景、前景帐户、标记、标记对象、用户、访问、访问者、访问者活动、访问者页面视图,访客推荐人
- 支持大多数API操作:查询、分配、取消分配、创建、读取、更新、更新、删除
- 支持取消设置字段值
- 隐式处理API会话超时
- 透明的API错误反馈
- 可选的请求重试,增量后退
计划功能
- 支持API版本4
- 对api批处理操作的支持:batchcreate、batchupdate、batchupsert
- 支持结果集操作,例如指定字段、限制、偏移量、排序方式、排序顺序
- 隐式结果分页
- 批处理操作的隐式分块
安装
$ pip install pardot-api-client
用法
按照http://developer.pardot.com/#authentication上的说明从pardot获取api身份验证凭据-您需要以下信息:电子邮件、密码、用户密钥
查看http://developer.pardot.com/#official-pardot-api-documentation上支持的pardot api文档
使用python api客户端与api交互:
>>>frompardot.clientimportAPIClient>>>client=APIClient(...'pardot-email',...'pardot-password',...'pardot-user_key')...>>># read>>>r=client.prospect.read('someone@example.com')>>>print(r)>>># update>>>r=client.prospect.update('someone@example.com',first_name='John')>>>print(r)>>># query>>>forrinclient.prospect.query(new=True):...print(r)...
参数vs关键字参数
为了保持客户端的api简单,它对资源操作调用中传递的标识符进行了有根据的猜测。
要使此工作正常,必须将所有必需的参数(用户密钥和API密钥除外,它们是自动添加的)作为位置参数传递,并将任何可选参数作为关键字参数传递。
例如,api文档说明,对“prospect”资源的“assign”操作可以使用“email”或“id”作为标识符,并且必须提供以下参数之一:“user_email”或“user_id”或“group_id”。以下任何表格都可用于从客户机进行此呼叫:
>>># identify by email>>>client.prospect.update('someone@example.com',user_email='someone-else@example.com')>>>client.prospect.update('someone@example.com',user_id=2544897)>>>client.prospect.update('someone@example.com',group_id=5499876)>>># identify by id>>>client.prospect.update(7142577,user_email='someone-else@example.com')>>>client.prospect.update(7142577,user_id=2544897)>>>client.prospect.update(7142577,group_id=5499876)