API 与访问密钥
更新于 27.10.2026
该平台有自己的API:与应用程序使用的相同。 通常的登录是用户会话,并且 访问密钥 为独立运行的脚本、集成或仪表板发布。
如何取得钥匙
密钥在接收“开发人员”页(地址/developers):在电脑上-在侧菜单项“申请表格”部分,在手机上-菜单中的相同项目“☰”或“设置” → “对于开发人员” → “API密钥和文档”. 登录后页面可见。 还有一个“API文档”链接(在新选项卡中打开)。 密钥与教师或员工的角色无关:该角色是在“我的角色”页,但钥匙不在那里。
有两种方法。 如果你的角色有权“在没有应用程序的情况下为自己发出API密钥”(或“发布和撤销API密钥”),密钥立即发出,没有应用程序-见“释放自己的钥匙”. 其余的人有一个由有权审查的人的申请。“发布和撤销API密钥”.
释放自己的钥匙
对于那些可以做到这一点的人,一个带有“释放键”按钮显示在页面上而不是应用程序上。 没有人在考虑它,所以通常由考虑它的人决定的一切,你自己决定。:
- 没有必要向谁或为了什么;密钥如何在列表中签名。 如果留空,标题将是目标的开始。
- 什么是允许的关键 是来自您角色的权利的标记,并且仅来自它们; “选择所有”和“取消选中所有”马上标记。 只标记脚本需要的内容。 没有标签,密钥只读取任何用户可用的内容,但具有自己的请求限制。
- 有效期至 需要。 默认情况下,一年后,不超过730天。 当截止日期到期时,密钥将停止工作—发出一个新的。
- 目标 是强制性的:什么将被称为以及多久。 它作为问题的原因保存在帐户上。
什么是“钥匙允许的”是“前有效”按钮有提示:在电脑上—通过指向,在手机上—通过长按。
之后“释放密钥”,旧的密钥,如果有一个,立即停止工作,新的出现在卡上的全部。 复制它与“副本”按钮。 问题以与批准的应用程序相同的方式记录在审核日志中(“API密钥发布”),并附有钥匙由业主本人签发的说明。 您可以将密钥释放给自己,每小时不超过五次。 虽然密钥是有效的,而不是页面上的表单,密钥本身应该是“重新印发”.
索取钥匙
申请中有两个必填字段:
- 给谁或为了什么 -什么会去的关键: “排程出口在院长”办公室, “部门机器人”, “grafana中的仪表板”. 然后,此行在已发出的密钥列表中可见。
- 目标 究竟是什么将被称为以及多久。 一个词就足够了,但根据这篇文章正在考虑应用程序:如果它不明白为什么需要密钥,应用程序将被拒绝并留下评论。
该“请求密钥”按钮发送请求。 这个应用程序被所有有权利的人看到。“发布和撤销API密钥”. 该解决方案来作为一个通知-在钟声,在推送和机器人,如果它连接。 一次一个申请正在等待。
审稿人决定什么
申请未获批准。“是的”或“非也。”,但与设置:
- 什么是允许的关键 是一组权利。 密钥不能大于其所有者:申请人角色没有的所有内容都被丢弃。
- 有效期至 密钥停止工作的日期。 您可以将其留空-然后密钥是无限期的。
- 名称 是密钥在列表中的签名方式;默认情况下,这是To “或者为了什么”字符串。
- 评论 是申请人将要阅读的内容。
的原因“问题保存在帐户上:一个关键图标出现在名称旁边的用户列表中,以及原因”行出现在用户的页面上。
如何使用密钥
密钥显示给其所有者在其全部相同“开发人员”收到它的页面: “出示钥匙”, “副本”它。 它从vish_;在列表中,键仅由第一个字符可见。
密钥在头中传递X-Api-Key:
curl -H "X-Api-Key: vish_..." https://api.<стенд>/api/v1/schedule/lessons
标题与Authorization这样密钥和会话就不会混淆了。 密钥请求是代表所有者的请求,但仅在授予的权利范围内:集合中没有的,密钥将被拒绝,即使该人自己拥有此权利。
所有方法的描述可在OpenAPI页面上找到,并在“API文档”菜单。 从哪里开始,如何登录,如何阅读时间表和参考书,以及JavaScript、Python和Go的例子,都在“开发人员”指南部分,从开发人员:开始页;上有这些页面的列表“开发人员”页。
补发及检讨
业主可以补发 钥匙自己通过点击“补发”在“开发人员”页。 旧线路在同一时刻停止工作—如果钥匙在某个地方点亮,这就是需要做的事情。 权利和术语保持不变。
密钥可以撤销 任何有权“发布和撤销API密钥”,在“申请表格”页,“已发出的钥匙”标签。 审查需要一个理由:它涉及到业主作为通知,并保持标记在他的帐户。 撤销的密钥无法恢复-需要一个新的应用程序(或一个新的问题,如果您可以将密钥发给自己)。
问题、补发和召回记录在审核日志中。
透过VISH
只要密钥有效,您就可以在同一个网站或应用程序上注册“开发人员页面至”使用帐户登录VISH: “以VISH -你的申请”节。 人们通过Telegram或MAX登录,应用程序只能获得他们允许的内容。 它是如何为读者、开发人员和管理员工作的登入VISH页。
验证:2026-10,PWA fbb681a8,平台3474bfa8._