短语 / phrase-php
短语字符串API参考。短语字符串是一个软件项目的翻译管理平台。您可以使用团队协作进行语言文件翻译或通过我们的平台订购翻译。API允许您导入区域文件、下载区域文件、标记键或以其他方式与存储在短语字符串中的本地化数据交互。
2.4.0
2024-09-09 07:48 UTC
Requires
- php: >=7.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^7.4
- squizlabs/php_codesniffer: ~2.6
README
短语字符串是一个软件项目的翻译管理平台。您可以使用团队协作进行语言文件翻译或通过我们的平台订购翻译。API允许您导入区域文件、下载区域文件、标记键或以其他方式与存储在短语字符串中的本地化数据交互。
此PHP包由OpenAPI Generator项目自动生成
- API版本:2.0.0
- 包版本:2.4.0
- 构建包:org.openapitools.codegen.languages.PhpClientCodegen 更多信息,请访问 https://developers.phrase.com/api/
需求
PHP 5.5及更高版本
安装与使用
Composer
要从Composer安装绑定器,请从Packagist运行控制台
composer require phrase/phrase-php
如果您希望从Github存储库通过Composer安装绑定器,请将以下内容添加到composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/phrase/phrase-php.git" } ], "require": { "phrase/phrase-php": "*@dev" } }
然后运行composer install
手动安装
下载文件并包含autoload.php
require_once('/path/to/phrase-php/vendor/autoload.php');
测试
要运行单元测试
composer install ./vendor/bin/phpunit
入门
请按照安装过程进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); $config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); $config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token'); $apiInstance = new Phrase\Api\AccountsApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $id = 'id_example'; // string | ID $x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional) try { $result = $apiInstance->accountShow($id, $x_phrase_app_otp); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountsApi->accountShow: ', $e->getMessage(), PHP_EOL; } ?>
数据中心
API仅通过HTTPS访问,当前版本为v2
,结果是一个类似于https://api.phrase.com/v2
的基本URL,具体取决于数据中心。
欧盟数据中心
https://api.phrase.com/v2
这是默认的数据中心。
美国数据中心
https://api.us.app.phrase.com/v2/
指定美国数据中心
您可以通过以下设置使用美国数据中心
$config = Phrase\Configuration::getDefaultConfiguration()->setHost('https://api.us.app.phrase.com/v2/');
授权文档
令牌
- 类型:API密钥
- API密钥参数名:Authorization
- 位置:HTTP头部
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); $config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');
基本
- 类型:HTTP基本身份验证
$config = Phrase\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD');
API端点文档
所有URI都是相对于https://api.phrase.com/v2
模型文档
- 账户
- 账户详情
- 账户搜索结果
- 受影响数量
- 受影响资源
- 授权
- 授权创建参数
- 授权更新参数
- 带有令牌的授权
- Bitbucket同步
- Bitbucket同步导出参数
- Bitbucket同步导出响应
- Bitbucket同步导入参数
- 黑名单键
- 黑名单键创建参数
- 黑名单键更新参数
- 分支
- 分支创建参数
- 分支合并参数
- 分支名称
- 分支更新参数
- 评论
- 评论创建参数
- 评论标记为已读参数
- 评论反应
- 评论更新参数
- 评论列表参数
- 当前用户
- 自定义元数据数据类型
- 自定义元数据属性创建参数
- 自定义元数据属性更新参数
- 自定义元数据属性
- 自定义元数据属性创建422响应
- 自定义元数据属性创建422响应错误内部
- 分发
- 分发创建参数
- 分发预览
- 分发更新参数
- 文档
- 错误
- 错误错误
- Figma附件
- Figma附件创建参数
- Figma附件更新参数
- 格式
- GitHub同步导出参数
- GitHub同步导入参数
- Gitlab同步
- Gitlab同步导出
- Gitlab同步导出参数
- Gitlab同步历史
- Gitlab同步历史错误内部
- Gitlab同步导入参数
- 术语表
- 术语表创建参数
- 术语表条目
- 术语表条目创建参数
- 术语表条目翻译
- 术语表条目翻译创建参数
- 术语表条目翻译更新参数
- 术语表条目更新参数
- 术语表更新参数
- ICU
- ICU骨架参数
- 邀请
- 邀请创建参数
- 邀请更新参数
- 邀请更新设置参数
- 任务
- 任务评论
- 任务评论创建参数
- 任务评论更新参数
- 任务完成参数
- 任务创建参数
- 任务详情
- 任务键创建参数
- 任务区域
- 任务区域完成参数
- 任务区域完成审查参数
- 任务区域重新打开参数
- 任务区域更新参数
- 任务区域创建参数
- 任务预览
- 任务重新打开参数
- 任务启动参数
- 任务模板
- 任务模板创建参数
- 任务模板详情
- 任务模板区域更新参数
- 任务模板区域
- 任务模板区域创建参数
- 任务模板预览
- 任务模板更新参数
- 任务更新参数
- 键创建参数
- 键链接
- 键链接批量删除参数
- 键链接创建参数
- 键链接索引400响应
- 键预览
- 键更新参数
- 键排除参数
- 键包含参数
- 键搜索参数
- 键标签参数
- 键取消标签参数
- 区域
- 区域创建参数
- 区域详情
- 区域下载
- 区域下载创建参数
- 区域下载参数
- 区域下载结果
- 区域预览
- 区域预览1
- 区域报告
- 区域统计
- 区域团队预览
- 区域更新参数
- 区域用户预览
- 成员
- 成员项目详情
- 成员项目详情项目角色内部
- 成员空间内部
- 成员更新参数
- 成员更新设置参数
- 通知
- 通知组
- 通知组详情
- 订单确认参数
- 订单创建参数
- 组织任务模板
- 组织任务模板创建参数
- 组织任务模板详情
- 组织任务模板区域更新参数
- 组织任务模板区域创建参数
- 组织任务模板更新参数
- 项目
- 项目创建参数
- 项目详情
- 项目区域
- 项目报告
- 项目简短
- 项目更新参数
- 项目质量绩效分数200响应
- 项目质量绩效分数200响应任意之一
- 项目质量绩效分数200响应任意之一数据
- 项目质量绩效分数200响应任意之一数据翻译内部
- 项目质量绩效分数200响应任意之一错误内部
- 项目质量绩效分数请求
- 发布
- 发布创建参数
- 发布创建参数1
- 发布预览
- 发布触发
- 发布更新参数
- 发布更新参数1
- 回复列表参数
- 仓库同步
- 仓库同步事件
- 仓库同步事件错误内部
- 截图
- 截图标记
- 截图标记创建参数
- 截图标记更新参数
- 截图更新参数
- 在账户中搜索参数
- 空间
- 空间1
- 空间创建参数
- 空间更新参数
- 空间项目创建参数
- 样式指南
- 样式指南创建参数
- 样式指南详情
- 样式指南预览
- 样式指南更新参数
- 订阅
- 标签
- 标签创建参数
- 带统计的标签
- 带统计的标签1统计
- 带统计的标签1统计1
- 团队
- 团队创建参数
- 团队详情
- 团队简短
- 团队更新参数
- 团队项目创建参数
- 团队空间创建参数
- 团队用户创建参数
- 翻译
- 翻译创建参数
- 翻译详情
- 翻译排除参数
- 翻译包含参数
- 翻译键
- 翻译键详情
- 翻译顺序
- 翻译父级
- 翻译审核参数
- 翻译取消验证参数
- 翻译更新参数
- 翻译验证参数
- 翻译版本
- 翻译版本及用户
- 翻译排除参数
- 翻译包含参数
- 翻译审核参数
- 翻译搜索参数
- 翻译取消验证参数
- 翻译验证参数
- 上传
- 上传摘要
- 用户
- 用户预览
- 变量
- 变量创建参数
- 变量更新参数
- Webhook
- Webhook创建参数
- Webhook投递
- Webhook更新参数
作者
获取帮助/支持
请联系 support@phrase.com,我们可以采取更直接的行动来寻找解决方案。