SuperAPI AI 工具集

iblai-api-invite

编程与开发

查看项目

更新于 10-15 22:16

技能介绍

用途:通过 ibl.ai 平台 API 管理某个组织的用户邀请,适合需要把新成员批量加入组织并可选分配用户组的场景。

认证与约定:基础地址为 https://api.iblai.app,每个请求都需带请求头 Authorization: Api-Token $IBLAI_API_KEY。路径变量中 {org} 对应 $IBLAI_ORG,{username} 对应 $IBLAI_USERNAME,接口位于 /api/catalog/invitations/ 下。尚未连接时先运行 /iblai-api-login 填充 IBLAI_ORG、IBLAI_USERNAME、IBLAI_API_KEY。

主要能力: 查询邀请:GET …/invitations/platform/?platform_key={org}&page={n}&page_size=5&sort=-id,可列出已接受/待处理的邀请,通过 page、page_size 分页,sort=-id 让最新邀请排在最前。 发送邀请:POST …/invitations/platform/,请求体包含 email、platform_key(必填)、redirect_to、source、active,以及来自 CSV 的 company_name、first_name、last_name、user_group、user_group_owner_email。批量发送时对每一行 CSV 调用一次该接口。设置 user_group / user_group_owner_email 可将被邀请人分配到用户组。

使用方式:先完成登录填充环境变量,再按上述 GET 或 POST 调用;表单类字段来自批量 CSV 列,platform_key 传组织标识。

限制与注意:发送邀请会向真实收件人发邮件,尤其是逐行 POST 的批量任务,发布前需与用户确认收件人名单;列表接口为分页返回,需逐页获取。资料未提供速率限制、错误码与配额说明。