lilt/lilt-connector-sdk-php
Composer 安装命令:
composer require lilt/lilt-connector-sdk-php
包简介
This document describes the Plugin API for Lilt's Connector platform. The Plugin API is intented to be used by developers who wish to build integrations into their desired systems. The purpose of this API is to enable content transfer and status monitoring for localization projects. - Read more abo
README 文档
README
This document describes the Plugin API for Lilt's Connector platform. The Plugin API is intented to be used by developers who wish to build integrations into their desired systems. The purpose of this API is to enable content transfer and status monitoring for localization projects.
- Read more about the concepts and workflows in the user guide.
- Test the API interactively via Swagger UI.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php:
<?php require_once('/path/to/lilt-connector-sdk-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new LiltConnectorSDK\Api\CreditTransactionsApi( // 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() ); $services_api_credit_transaction_create_credit_transaction_request = new \LiltConnectorSDK\Model\ServicesApiCreditTransactionCreateCreditTransactionRequest(); // \LiltConnectorSDK\Model\ServicesApiCreditTransactionCreateCreditTransactionRequest try { $apiInstance->servicesApiCreditTransactionCreateCreditTransaction($services_api_credit_transaction_create_credit_transaction_request); } catch (Exception $e) { echo 'Exception when calling CreditTransactionsApi->servicesApiCreditTransactionCreateCreditTransaction: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://connectors-admin.lilt.com/api/v1.0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CreditTransactionsApi | servicesApiCreditTransactionCreateCreditTransaction | POST /credit-transaction | Create a credit transaction. Request is expected to contain credits information encoded in jwt_token payload. Request encoded should have info for instant_translation_credits_change value, verified_translation_credits_change value, source_metadata which contains any identifying information to attach to the transaction, email for the user starting the transaction, and optionally lilt_token for the connector configuration. |
| JobsApi | servicesApiJobsAddFile | POST /jobs/{id}/files | Add a file to a Job. |
| JobsApi | servicesApiJobsCreateJob | POST /jobs | Create a Connector Job. |
| JobsApi | servicesApiJobsDeleteJobById | DELETE /jobs/{id} | Delete a Connector Job. |
| JobsApi | servicesApiJobsGetJobById | GET /jobs/{id} | Retrieve a Connector Job. |
| JobsApi | servicesApiJobsGetJobs | GET /jobs | Retrieve a list of Connector Jobs. |
| JobsApi | servicesApiJobsStartJob | POST /jobs/{id}/start | Start a Job. |
| JobsApi | servicesApiJobsSyncJob | POST /jobs/{id}/sync | Start a Sync. |
| JobsApi | servicesApiJobsUpdateJob | PUT /jobs/{id} | Update a Connector Job. |
| OrganizationApi | servicesApiOrganizationGetOrganizationRecord | GET /organization | Get information about the organization based on lilt_token |
| RegistrationApi | servicesApiRegistrationRegisterCreditsBasedOrganization | POST /register | Register a new Connectors Organization |
| SettingsApi | servicesApiSettingsGetSettings | GET /settings | Retrieve the settings. |
| SettingsApi | servicesApiSettingsUpdateSettings | PUT /settings | Update the settings. |
| TranslationsApi | servicesApiDeliveriesCompleteDelivery | POST /translations/{id}/complete | Complete a Translation. |
| TranslationsApi | servicesApiDeliveriesDownloadDelivery | GET /translations/{id}/download | Download a Translation. |
| TranslationsApi | servicesApiDeliveriesDownloadDeliverySource | GET /translations/{id}/source | Download a Translation Source. |
| TranslationsApi | servicesApiDeliveriesGetDeliveriesByJobId | GET /translations | Retrieve a list of Translations. |
| TranslationsApi | servicesApiDeliveriesGetDeliveryById | GET /translations/{id} | Retrieve a Translation. |
| TranslationsApi | servicesApiDeliveriesUpdateDelivery | PUT /translations/{id} | Update a Translation. |
Models
- ErrorResponse
- JobResponse
- JobsResponse
- NewJobOptions
- NewOrganizationOptions
- OrganizationResponse
- ServicesApiCreditTransactionCreateCreditTransactionRequest
- SettingsResponse
- TranslationResponse
- TranslationsResponse
- UpdateDeliveryOptions
- UpdateJobOptions
Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0 - Build package:
org.openapitools.codegen.languages.PhpClientCodegen
lilt/lilt-connector-sdk-php 适用场景与选型建议
lilt/lilt-connector-sdk-php 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 9.06k 次下载、GitHub Stars 达 0, 最近一次更新时间为 2022 年 06 月 13 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「php」 「rest」 「api」 「sdk」 「openapi」 「openapitools」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 lilt/lilt-connector-sdk-php 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 lilt/lilt-connector-sdk-php 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 lilt/lilt-connector-sdk-php 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐,方便对比选型:
A PSR-7 compatible library for making CRUD API endpoints
Api bundle
Alfabank REST API integration
A Flickr wrapper to allow you to call the Flickr api with Guzzle as the backend.Goal is to have 100% Flickr api coverage rather than just upload/display photos (currently at 23%).
BlockCypher's PHP SDK for REST API
Helper classes for creating cookie headers
统计信息
- 总下载量: 9.06k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 26
- 依赖项目数: 1
- 推荐数: 0
其他信息
- 授权协议: unlicense
- 更新时间: 2022-06-13