crayon / arta-php-sdk
Arta 公共 API 提供报价生成、运输预订和跟踪功能。此外,API 还允许 Arta 合作伙伴组织为他们的账户配置电子邮件和 webhook 通知。
0.2
2024-01-03 18:08 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
Arta 公共 API 提供报价生成、运输预订和跟踪功能。此外,API 还允许 Arta 合作伙伴组织为他们的账户配置电子邮件和 webhook 通知。
更多信息,请访问 https://manual.arta.io/.
安装 & 使用
需求
PHP 7.4 及更高版本。也应与 PHP 8.0 兼容。
Composer
要使用 Composer 安装绑定,请将以下内容添加到 composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
然后运行 composer install
手动安装
下载文件并包含 autoload.php
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
入门
请遵循 安装程序,然后运行以下操作
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: apiKeyAuth $config = Arta\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Arta\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new Arta\Client\Api\ApiKeysApi( // 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 ); $authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token $api_keys_create_request = new \Arta\Client\Model\ApiKeysCreateRequest(); // \Arta\Client\Model\ApiKeysCreateRequest try { $result = $apiInstance->apiKeysCreate($authorization, $api_keys_create_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ApiKeysApi->apiKeysCreate: ', $e->getMessage(), PHP_EOL; }
API 端点
所有 URI 都是相对于 https://api.arta.io
模型
- ApiKey
- ApiKeyList
- ApiKeysCreateRequest
- ApiKeysCreateRequestApiKey
- Attachment
- AttachmentList
- AttachmentsCreateRequest
- AttachmentsCreateRequestAttachment
- BasicError
- BasicErrorErrors
- EmailRule
- EmailRuleList
- EmailRulesCreateRequest
- EmailRulesCreateRequestEmailRule
- EmailRulesUpdateRequest
- EmailRulesUpdateRequestEmailRule
- EmailSubscription
- EmailSubscriptionList
- EmailSubscriptionsCreateRequest
- EmailSubscriptionsCreateRequestEmailSubscription
- EmailSubscriptionsUpdateRequest
- EmailSubscriptionsUpdateRequestEmailSubscription
- HostedSession
- HostedSessionList
- Invoice
- InvoiceList
- InvoicePayment
- InvoicePaymentList
- Location
- LocationContactsInner
- Log
- LogList
- MetadalocationAccessRestrictions200ResponseInner
- MetadataApiVersions200ResponseInner
- MetadataCurrencies200ResponseInner
- MetadataEmailNotifications200ResponseInner
- MetadataInsurances200ResponseInner
- MetadataObjectMaterials200ResponseInner
- MetadataObjects200ResponseInner
- MetadataObjects200ResponseInnerSubtypesInner
- MetadataPackageStatuses200ResponseInner
- MetadataPackings200ResponseInner
- MetadataPackings200ResponseInnerSubtypesInner
- MetadataParcelTransportServices200ResponseInner
- MetadataPaymentProcessTypes200ResponseInner
- MetadataQuotes200ResponseInner
- MetadataRequestStatuses200ResponseInner
- MetadataServices200ResponseInner
- MetadataServices200ResponseInnerSubtypesInner
- MetadataServices200ResponseInnerSubtypesInnerSubSubtypesInner
- MetadataShipmentExceptionTypes200ResponseInner
- MetadataShipmentStatuses200ResponseInner
- NullableLocation
- NullableLocationContactsInner
- Organization
- OrganizationPatchRequest
- OrganizationPatchRequestOrganization
- PaginationMetadata
- Payment
- PaymentList
- Request
- RequestBookable
- RequestDisqualificationsInner
- RequestList
- RequestListItemsInner
- RequestListItemsInnerBookable
- RequestListItemsInnerDestination
- RequestListItemsInnerOrigin
- RequestObjectsInner
- RequestObjectsInnerDetails
- RequestQuotesInner
- RequestQuotesInnerIncludedInsurancePolicy
- RequestQuotesInnerIncludedServicesInner
- RequestQuotesInnerIncludedServicesInnerIncludedServicesInner
- RequestQuotesInnerOptionalServicesInner
- RequestsCreateRequest
- RequestsCreateRequestRequest
- RequestsCreateRequestRequestDestination
- RequestsCreateRequestRequestDestinationContactsInner
- RequestsCreateRequestRequestObjectsInner
- RequestsCreateRequestRequestObjectsInnerDetails
- RequestsCreateRequestRequestOrigin
- RequestsCreateRequestRequestOriginContactsInner
- RequestsCustomRequest
- RequestsUpdateContactsRequest
- RequestsUpdateContactsRequestDestination
- RequestsUpdateContactsRequestDestinationContactsInner
- RequestsUpdateContactsRequestOrigin
- RequestsUpdateContactsRequestOriginContactsInner
- Shipment
- ShipmentExceptionsCreate201Response
- ShipmentExceptionsCreateRequest
- ShipmentExceptionsCreateRequestShipmentException
- ShipmentExceptionsGet200Response
- ShipmentExceptionsInner
- 发货异常列表200响应
- 发货异常列表200响应项目内部
- 发货异常列表200响应元数据
- 发货异常更新200响应
- 发货异常更新请求
- 发货异常更新请求发货异常
- 发货保险单
- 发货列表
- 发货列表项目内部
- 发货列表项目内部目的地
- 发货列表项目内部起源
- 发货包装内部
- 发货包装内部对象内部
- 发货包装内部对象内部详情
- 发货计划
- 发货服务内部
- 发货跟踪内部
- 创建发货请求
- 创建发货请求发货
- 跟踪
- 跟踪承运人
- 上传
- 上传列表
- 带有预签名URL的上传
- 创建上传请求
- 创建上传请求上传
- Webhook
- Webhook投递
- Webhook投递列表
- Webhook投递列表项
- Webhook列表
- 创建Webhook请求
- 创建Webhook请求Webhook
- Webhook修补请求
- Webhook修补请求Webhook
- WebhooksSecretTokenGet200响应
- WebhooksSecretTokenResetPatch200响应
授权
API定义的认证方案
apiKeyAuth
- 类型: API密钥
- API密钥参数名称: 授权
- 位置: HTTP头
测试
要运行测试,请使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包是由OpenAPI Generator项目自动生成的
- API版本:
2021-01-01
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen