README

如果您想连接到实时API服务器，请使用 https://api.eurotext.de，对于沙盒测试请使用 https://sandbox.api.eurotext.de。

注意：默认情况下，客户端连接到沙盒API！这种行为可以在配置对象中配置。

可用端点

API提供了各种端点。此客户端仅实现了对以下端点的访问

管理项目

创建 (POST)

连接到 /api/v1/project/{project}

创建一个新的项目，期望一个 ProjectPostRequest 对象

检索 (GET)

连接到 /api/v1/project/{project}

检索项目数据，期望一个 ProjectGetRequest 对象

更改状态 (PATCH)

连接到 /api/v1/transition/project/{project}.json

转换项目状态，期望一个 ProjectTransitionRequest 对象

伪翻译 (PATCH)

连接到 /api/v1/project/translate/{project}.json

使用伪翻译字符串将项目中的所有项目翻译，期望一个 ProjectTranslateRequest 对象

管理项目

创建 (POST)

连接到 /api/v1/project/{project}/item/{item}

创建一个新的项目，期望一个 ItemPostRequest 对象

检索 (GET)

连接到 /api/v1/project/{project}/item/{item}

检索项目数据，期望一个 ItemGetRequest 对象

内部机制

此客户端使用面向对象编程和依赖注入。

要创建一个项目请求，您首先需要使用配置实例化客户端

// define your api key provided by Eurotext
$apiKey = 'myCustomAPIKey';

// create configuration with your key
$config = new Configuration();
$config->setApiKey($apiKey);

// instantiate project API object
$projectApi = new ProjectV1Api($config);

// create project data object
$projectData = new ProjectData('Project Description');

// create post request object with project data
$request = new ProjectPostRequest('Project Name', $projectData, ProjectTypeEnum::QUOTE());

// send request via project API's POST request
$response = $projectApi->post($request);

// retrieve API project id from result
$createdProjectId = $response->getId();

使用依赖注入，您可以创建自己的数据或请求对象，只要您实现了所需的接口。这些接口由相应的方法所要求，如果您没有实现它们，将抛出异常。这种方法迫使您创建API所需的所有方法。