钉钉应用服务商(ISV)接口

class dingtalk.client.isv.ISVClient(suite_key, suite_secret, token=None, aes_key=None, storage=None, timeout=None, auto_retry=True)[源代码]
activate_suite(corp_id)[源代码]

激活套件

参数:corp_id – 授权方corpid
返回:
get(uri, params=None, **kwargs)

get 接口请求

参数:
  • uri – 请求url
  • params – get 参数(dict 格式)
get_access_token_by_corpid(corp_id)[源代码]

获取企业授权的凭证

参数:corp_id – 授权方corpid
返回:
get_agent(corp_id, agent_id)[源代码]

获取企业的应用信息

参数:
  • corp_id – 授权方corpid
  • agent_id – 授权方应用id
返回:

get_auth_info(corp_id)[源代码]

获取企业基本信息

参数:corp_id – 授权方corpid
返回:
get_channel_token_by_corpid(corp_id)[源代码]

ISV获取企业服务窗接口调用TOKEN

参数:corp_id – 授权方corpid
返回:
get_permanent_code(tmp_auth_code)[源代码]

获取企业授权的永久授权码

参数:tmp_auth_code – 回调接口(tmp_auth_code)获取的临时授权码
返回:
get_suite_access_token()[源代码]

获取应用套件令牌Token

返回:
get_unactive_corp(app_id)[源代码]

获取应用未激活的企业列表

参数:app_id – 套件下的微应用ID
返回:
post(uri, data=None, params=None, **kwargs)

post 接口请求

参数:
  • uri – 请求url
  • data – post 数据(dict 格式会自动转换为json)
  • params – post接口中url问号后参数(dict 格式)
reauth_corp(app_id, corpid_list)[源代码]

重新授权未激活应用的企业

参数:
  • app_id – 套件下的微应用ID
  • corpid_list – 未激活的corpid列表
返回:

set_corp_ipwhitelist(corp_id, ip_whitelist)[源代码]

ISV为授权方的企业单独设置IP白名单

参数:
  • corp_id – 授权方corpid
  • ip_whitelist – 要为其设置的IP白名单,格式支持IP段,用星号表示,注意:仅支持后两段设置为星号
返回:

top_request(method, params=None, format_='json', v='2.0', simplify='false', partner_id=None, url=None, **kwargs)

top 接口请求

参数:
  • method – API接口名称。
  • params – 请求参数 (dict 格式)
  • format – 响应格式(默认json,如果使用xml,需要自己对返回结果解析)
  • v – API协议版本,可选值:2.0。
  • simplify – 是否采用精简JSON返回格式
  • partner_id – 合作伙伴身份标识。
  • url – 请求url,默认为 https://eco.taobao.com/router/rest

ISVClient 基本使用方法:

from dingtalk import ISVClient

client = ISVClient('corp_id', 'secret', 'token', 'aes_key')
corp_info = client.get_auth_info('corpid')

corp_client = client.get_dingtalk_client('corpid')
user = corp_client.user.get('userid')
departments = corp_client.department.list()
# 以此类推,corp_client可针对企业执行api

如果不提供 storage 参数,默认使用 dingtalk.storage.memorystorage.MemoryStorage 类型, 注意该类型不是线程安全的,而且非持久化保存,不推荐生产环境使用。