ifb-wrapper的Python项目详细描述
ifb包装器
ifb包装器是一个开源项目，用于简化和标准化与iformbuilder软件的集成。ifb wrapper是用python编写的，它允许您快速开始创建集成，而无需学习api身份验证和结构的细节。
安装
要安装ifb包装器，请确保已安装python3+。使用pip install ifb-wrapper下载。
开始
要启动新项目，请从导入库开始：
from ifb import IFB
要创建api对象，请将服务器名称、客户端id和客户端机密传递给IFB()
from ifb import IFB
api = IFB("app.iformbuilder.com","**********","**********")
就这样！ifb对象需要请求访问令牌所需的凭据。有关创建iformbuilder api应用程序的更多信息，请访问：https://iformbuilder.zendesk.com/hc/en-us/articles/201702900-What-are-the-API-Apps-Start-Here-
如何贡献
这个图书馆正在建设中，如有任何帮助，我们将不胜感激。有几种方法可以为本项目做出贡献，概述如下：
IFormBuilder资源参考
额外功能
| Function | Description |
|---|
| genPassword(n) | Return a password ^{} characters long that includes a minimum of 1 special character, uppercase letter, and digit |
| sortOptionList(profile_id,option_list_id,reverse) | Sort a given option list by key value. Reverse sort order if ^{} True |
| replaceRecords(profile_id,page_id,data) | Delete all records in a table and create records from ^{} |
| deletePersonalData(profile_id,page_id) | Delete data in elements with 'Personal Data' checkbox |
令牌资源
| Method | Resource | Function |
|---|
| POST | Token | requestAccessToken() |
剖面图
| Method | Resource | Function |
|---|
| POST | Profile | createProfile |
| GET | Profile | readProfile |
| GET | Profiles | readProfiles |
| GET | * | readAllProfiles |
| PUT | Profile | updateProfile |
| DELETE | Profile | deleteProfile |
| DELETE | Profiles | deleteProfiles |
| Method | Resource | Function |
|---|
| GET | Company Info | readCompanyInfo |
用户
| Method | Resource | Function |
|---|
| POST | Users | createUsers |
| GET | User | readUser |
| GET | Users | readUsers |
| GET | * | readAllUsers |
| PUT | User | updateUser |
| PUT | Users | updateUsers |
| DELETE | User | deleteUser |
| DELETE | Users | deleteUsers |
| Method | Resource | Function |
|---|
| POST | User Group | createUserGroups |
| GET | User | readUserGroup |
| GET | User Groups | readUserGroups |
| PUT | User Group | updateUserGroup |
| PUT | User Groups | updateUserGroups |
| DELETE | User Group | deleteUserGroup |
| DELETE | User Groups | deleteUserGroups |
| Method | Resource | Function |
|---|
| POST | User Page Assignments | createUserPageAssignments |
| GET | User Page Assignment | readUserPageAssignment |
| GET | User Page Assignments | readUserPageAssignments |
| GET | * | readAllUserPageAssignments |
| PUT | User Page Assignment | updateUserPageAssignment |
| PUT | User Page Assignments | updateUserPageAssignments |
| DELETE | User Page Assignment | deleteUserPageAssignment |
| DELETE | User Page Assignments | deleteUserPageAssignments |
| Method | Resource | Function |
|---|
| POST | User Record Assignments | createUserRecordAssignments |
| GET | User Record Assignment | readUserRecordAssignment |
| GET | User Record Assignments | readUserRecordAssignments |
| PUT | User Record Assignment | updateUserRecordAssignment |
| PUT | User Record Assignments | updateUserRecordAssignments |
| DELETE | User Record Assignment | deleteUserRecordAssignment |
| DELETE | User Record Assignments | deleteUserRecordAssignments |
页码
| Method | Resource | Function |
|---|
| POST | Page | createPage |
| GET | Page | readPage |
| GET | Pages | readPages |
| GET | * | readAllPages |
| PUT | Page | updatePage |
| PUT | Pages | updatePages |
| DELETE | Page | deletePage |
| DELETE | Pages | deletePages |
| Method | Resource | Function |
|---|
| POST | Page Group | createPageGroup |
| GET | Page Group | readPageGroup |
| GET | Page Groups | readPageGroups |
| PUT | Page Group | updatePageGroup |
| PUT | Page Groups | updatePageGroups |
| DELETE | Page Group | deletePageGroup |
| DELETE | Page Groups | deletePageGroups |
| Method | Resource | Function |
|---|
| POST | Page Assignments | createPageAssignments |
| GET | Page Assignment | readPageAssignment |
| GET | Page Assignments | readPageAssignments |
| GET | * | readAllPageAssignments |
| PUT | Page Assignment | updatePageAssignment |
| PUT | Page Assignments | updatePageAssignments |
| DELETE | Page Assignment | deletePageAssignment |
| DELETE | Page Assignments | deletePageAssignments |
| Method | Resource | Function |
|---|
| POST | Page Record Assignments | createPageRecordAssignments |
| GET | Page Record Assignment | readPageRecordAssignment |
| GET | Page Record Assignments | readPageRecordAssignments |
| PUT | Page Record Assignment | updatePageRecordAssignment |
| PUT | Page Record Assignments | updatePageRecordAssignments |
| DELETE | Page Record Assignment | deletePageRecordAssignment |
| DELETE | Page Record Assignments | deletePageRecordAssignments |
| Method | Resource | Function |
|---|
| POST | Shared Page Entries | createPageShares |
| GET | Shared Page Entries | readPageShares |
| PUT | Shared Page Entries | updatePageShares |
| DELETE | Shared Page Entries | deletePageShares |
| Method | Resource | Function |
|---|
| GET | Page Dependencies | readPageDependencies |
| Method | Resource | Function |
|---|
| POST | Page Dynamic Attributes | createPageDynamicAttributes |
| GET | Page Dynamic Attribute | readPageDynamicAttribute |
| GET | Page Dynamic Attributes | readPageDynamicAttributes |
| PUT | Page Dynamic Attribute | updatePageDynamicAttribute |
| PUT | Page Dynamic Attributes | updatePageDynamicAttributes |
| DELETE | Page Dynamic Attribute | deletePageDynamicAttribute |
| DELETE | Page Dynamic Attributes | deletePageDynamicAttributes |
| Method | Resource | Function |
|---|
| POST | Page Localizations | createPageLocalizations |
| GET | Page Localization | readPageLocalization |
| GET | Page Localizations | readPageLocalizations |
| PUT | Page Localization | updatePageLocalization |
| PUT | Page Localizations | updatePageLocalizations |
| DELETE | Page Localization | deletePageLocalization |
| DELETE | Page Localizations | deletePageLocalizations |
| Method | Resource | Function |
|---|
| POST | HTTP Callback | createPageEndpoints |
| GET | HTTP Callback | readPageEndpoint |
| GET | HTTP Callbacks | readPageEndpoints |
| PUT | HTTP Callback | updatePageEndpoint |
| PUT | HTTP Callbacks | updatePageEndpoints |
| DELETE | HTTP Callback | deletePageEndpoint |
| DELETE | HTTP Callbacks | deletePageEndpoints |
| Method | Resource | Function |
|---|
| POST | Email Alert | createPageEmailAlert |
| GET | Email Alert | readPageEmailAlerts |
| Method | Resource | Function |
|---|
| GET | Private Media | readPrivateMedia |
| Method | Resource | Function |
|---|
| POST | Trigger POST Action | createPageTriggerPost |
| Method | Resource | Function |
|---|
| GET | Page Feed | readPageFeed |
元素
| Method | Resource | Function |
|---|
| POST | Elements | createElements |
| GET | Element | readElement |
| GET | Elements | readElements |
| GET | * | readAllElements |
| PUT | Element | updateElement |
| PUT | Elements | updateElements |
| DELETE | Element | deleteElement |
| DELETE | Elements | deleteElements |
| Method | Resource | Function |
|---|
| POST | Element Dynamic Attributes | createElementDynamicAttributes |
| GET | Element Dynamic Attribute | readElementDynamicAttribute |
| GET | Element Dynamic Attributes | readElementDynamicAttributes |
| PUT | Element Dynamic Attribute | updateElementDynamicAttribute |
| PUT | Element Dynamic Attributes | updateElementDynamicAttributes |
| DELETE | Element Dynamic Attribute | deleteElementDynamicAttribute |
| DELETE | Element Dynamic Attributes | deleteElementDynamicAttributes |
| Method | Resource | Function |
|---|
| POST | Element Localizations | createElementLocalizations |
| GET | Element Localization | readElementLocalization |
| GET | Element Localizations | readElementLocalizations |
| PUT | Element Localization | updateElementLocalization |
| PUT | Element Localizations | updateElementLocalizations |
| DELETE | Element Localization | deleteElementLocalization |
| DELETE | Element Localizations | deleteElementLocalizations |
选项列表
| Method | Resource | Function |
|---|
| POST | Option List | createOptionList |
| GET | Option List | readOptionList |
| GET | Option Lists | readOptionLists |
| GET | | readAllOptionLists |
| PUT | Option List | updateOptionList |
| PUT | Option Lists | updateOptionLists |
| DELETE | Option List | deleteOptionList |
| DELETE | Option Lists | deleteOptionLists |
| Method | Resource | Function |
|---|
| GET | Option List Dependencies | readOptionListDependencies |
选项
| Method | Resource | Function |
|---|
| POST | Options | createOptions |
| GET | Option | readOption |
| GET | Options | readOptions |
| GET | * | readAllOptions |
| PUT | Option | updateOption |
| PUT | Options | updateOptions |
| DELETE | Option | deleteOption |
| DELETE | Options | deleteOptions |
| Method | Resource | Function |
|---|
| POST | Option Localizations | createOptionLocalizations |
| GET | Option Localization | readOptionLocalization |
| GET | Option Localizations | readOptionLocalizations |
| PUT | Option Localization | updateOptionLocalization |
| PUT | Option Localizations | updateOptionLocalizations |
| DELETE | Option Localization | deleteOptionLocalization |
| DELETE | Option Localizations | deleteOptionLocalizations |
记录
| Method | Resource | Function |
|---|
| POST | Records | createRecords |
| GET | Record | readRecord |
| GET | Records | readRecords |
| GET | * | readAllRecords |
| PUT | Record | updateRecord |
| PUT | Records | updateRecords |
| DELETE | Record | deleteRecord |
| DELETE | Records | deleteRecords |
| DELETE | * | deleteAllRecords |
| Method | Resource | Function |
|---|
| POST | Record Assignments | createRecordAssignments |
| GET | Record Assignment | readRecordAssignment |
| GET | Record Assignments | readRecordAssignments |
| PUT | Record Assignment | updateRecordAssignment |
| PUT | Record Assignments | updateRecordAssignments |
| DELETE | Record Assignment | deleteRecordAssignment |
| DELETE | Record Assignments | deleteRecordAssignments |
通知
| Method | Resource | Function |
|---|
| POST | Notification | createNotification |
设备许可证
| Method | Resource | Function |
|---|
| GET | Device License | readDeviceLicense |
| GET | Device Licenses | readDeviceLicenses |
更改日志
- 1.5.3：添加日志记录
app.log、刷新前访问令牌检查和执行时间IFB.getExecutionTime() - 1.5.2：向ifb类添加了api_calls属性，用于计算脚本中的api调用
- 1.5.1:添加了ReadPageDependencies（）
- 1.5.0:如果当前访问令牌上的剩余时间少于5分钟，则访问令牌将刷新
- 1.4.3：新增共享页面资源、邮件提醒资源、页面馈送资源、私人媒体资源
- 1.4.2:添加设备许可资源
- 1.4.1:从setup.py install_中删除“csv”需要
- 1.4.0:添加了replaceRecords（）、deletePersonalData（）和createNotification（）
- 1.3.0:添加了deleteAllRecords（）
- 1.2.0:添加了createPageTriggerPost（）和sortoptionList（）
- 1.1.2：从依赖项列表中删除机密和字符串
- 1.1.1：从依赖项列表中随机删除
- 1.1.0:添加了新方法genpassword（n）以创建长度为n个字符的密码
- 1.0.1:修复了createusergroup（）函数中的输入错误，并修改了入门示例
- 1.0.0:1.0版万岁！
欢迎加入QQ群-->： 979659372
推荐PyPI第三方库
