multinetinteractive/eduadmin-api-phpclient

dev-master 2024-06-03 12:29 UTC

This package is auto-updated.

Last update: 2024-09-18 06:52:01 UTC


README

在您希望使用API客户端针对EduAdmin的页面中包含eduadmin-api-client.php

这将启用全局命令EDUAPI(),它是一个客户端的单例实例。

不要忘记调用EDUAPI()->SetCredentials( $api_user, $api_pass ),然后通过调用EDUAPI()->GetToken()获取令牌。

该令牌目前有效期为两周,因此请将其保存在安全的地方。(永远不要向公众展示)

令牌有一个检查其有效性的功能,但仅针对过期。因此,如果您从API收到错误,请跟踪错误,然后应请求新的令牌。

以下是当前在OData-属性中的端点列表

  • 预订
  • 类别
  • 国家
  • 课程级别
  • 课程模板
  • 客户组
  • 客户
  • 自定义字段
  • 活动
  • 成绩
  • 兴趣注册
  • 位置
  • 参与者
  • 付款条款
  • 人员
  • 人员
  • 价格名称
  • 课程预订
  • 课程
  • 课程兴趣注册
  • 课程开始
  • 地区
  • 报告
  • 科目

所有这些端点都支持以下功能

...->Search(
    $select,    // Nullable, adds the $select-parameter
    $filter,    // Nullable, adds the $filter-parameter
    $expand,    // Nullable, adds the $expand-parameter
    $orderby,   // Nullable, adds the $orderby-parameter
    $top,       // Nullable, adds the $top-parameter
    $skip,      // Nullable, adds the $skip-parameter
    $count      // Boolean, if true, adds number of records to result
)
...->GetItem(
    $id,        // The ID (Integer) of the resource you're getting
    $select,    // Nullable, adds the $select-parameter
    $expand     // Nullable, adds the $expand-parameter
)

OData-端点从EduAdminODataClient继承,它从EduAdminRESTClient继承,但此类明确禁止您使用GETPOSTPATCHPUTDELETE方法。

当前在REST-属性中的端点是

  • 预订
  • 优惠券
  • 同意
  • 客户
  • 活动
  • 兴趣注册
  • 组织
  • 参与者
  • 人员
  • 人员
  • 课程预订
  • 课程开始
  • 报告

每个端点都包含其自己的方法,但它也继承自EduAdminRESTClient,因此您将能够访问GETPOSTPATCHPUTDELETE方法。

如果您想自己制作某些内容,可以查看API文档