mittwald/api-client

mittwald mStudio v2 API 的客户端库

v2.1.64 2024-09-19 19:10 UTC

README

此软件包包含一个(主要自动生成)PHP客户端,用于mittwald mStudio v2 API。

许可证

版权所有 (c) 2023 Mittwald CM Service GmbH & Co. KG 及贡献者

本项目采用MIT许可证;有关详细信息,请参阅LICENSE文件。

安装

您可以使用composer安装此软件包

$ composer require mittwald/api-client

用法

导入客户端

use Mittwald\ApiClient\MittwaldAPIV2Client;

要创建客户端实例,您可以使用以下工厂方法之一,用于不同类型的身份验证

  1. MittwaldAPIClient::newUnauthenticated()
  2. MittwaldAPIClient::newWithToken(string $apiToken)(推荐)
  3. MittwaldAPIClient::newWithCredentials(string $email, string $password)(实际上在后台执行登录操作;在启用双因素认证时不可用)

有关如何获取API令牌以及如何开始使用API的更多信息,请参阅我们的API简介

示例

use \Mittwald\ApiClient\Generated\V2\Clients\Project\ListProjects\ListProjectsRequest;

$listProjectRequest = new ListProjectsRequest();
$listProjectResponse = $client->project()->listProjects($listProjectRequest);

foreach ($listProjectResponse->getBody() as $project) {
    echo $project->getShortId() . PHP_EOL;
}

API文档

API文档可以在我们的开发者门户中找到。您可以在每个操作的右侧找到操作ID。