包简介

PHP client for the Openprovider REST API

README 文档

README

Inspired by Openprovider's version which is unfortunately outdated at the moment of writing.

The code in this package is generated by the OpenAPI Generator project

Installation & Usage

Requirements

PHP 7.4 and later

Composer

Run composer require savvii/openprovider-rest

Getting Started

Example for PHP 8.0 or newer because it really helps to be able to use Named Arguments.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = \Savvii\OpenproviderRest\Configuration::getDefaultConfiguration();
$config->setApiKeyPrefix('Authorization', 'Bearer');
$config->setDebug(false);

$loginResult = (new \Savvii\OpenproviderRest\Api\AuthApi())->login(
    new \Savvii\OpenproviderRest\Model\AuthLoginRequest([
        'username' => '__FILL_ME__',
        'password' => '__FILL_ME__'
    ])
);

$config->setApiKey('Authorization', $loginResult->getData()->getToken());

$domainApi = new \Savvii\OpenproviderRest\Api\DomainServiceApi(config: $config);
$listResponse = $domainApi->listDomains(full_name: 'savvii.nl', limit: 1);
$data = $listResponse->getData();
if (1 == $data->getTotal())
{
    $result = $data->getResults()[0];
    printf("ID: %d, Auth Code: %s\n\n", $result->getId(), $result->getAuthCode());
    $arrayResult = json_decode($result, true);
    var_dump($arrayResult);
}

API Endpoints

All URIs are relative to https://api.openprovider.eu

Class	Method	HTTP request	Description
AdditionalDataApi	getAdditionalData	GET /v1beta/domains/additional-data	Get additional data
ApproverEmailApi	listApproverEmails	GET /v1beta/ssl/approver-emails	List approver emails
AuthApi	login	POST /v1beta/auth/login	Login with username and password
AuthCodeApi	getAuthCode	GET /v1beta/domains/{id}/authcode	Get auth code
AuthCodeApi	resetAuthCode	POST /v1beta/domains/{id}/authcode/reset	Reset auth code
ContactServiceApi	createContact	POST /v1beta/contacts	Create contact
ContactServiceApi	deleteContact	DELETE /v1beta/contacts/{id}	Delete contact
ContactServiceApi	getContact	GET /v1beta/contacts/{id}	Get contact
ContactServiceApi	listContacts	GET /v1beta/contacts	List contacts
ContactServiceApi	updateContact	PUT /v1beta/contacts/{id}	Update contact
CsrApi	createCsr	POST /v1beta/ssl/csr	Create csr
CsrApi	decodeCsr	POST /v1beta/ssl/csr/decode	Decode csr
CustomerApi	createCustomer	POST /v1beta/customers	Create customer
CustomerApi	deleteCustomer	DELETE /v1beta/customers/{handle}	Delete customer
CustomerApi	getCustomer	GET /v1beta/customers/{handle}	Get customer
CustomerApi	listCustomers	GET /v1beta/customers	List customers
CustomerApi	updateCustomer	PUT /v1beta/customers/{handle}	Update customer
CustomerAdditionalDataApi	getData	GET /v1beta/domains/additional-data/customers	Get data
DomainPriceServiceApi	getPrice	GET /v1beta/domains/prices	Get price
DomainServiceApi	approveTransfer	POST /v1beta/domains/{id}/transfer/approve	Approve transfer
DomainServiceApi	checkDomain	POST /v1beta/domains/check	Check domain
DomainServiceApi	createDomain	POST /v1beta/domains	Create domain
DomainServiceApi	deleteDomain	DELETE /v1beta/domains/{id}	Delete domain
DomainServiceApi	getDomain	GET /v1beta/domains/{id}	Get domain
DomainServiceApi	listDomains	GET /v1beta/domains	List domains
DomainServiceApi	renewDomain	POST /v1beta/domains/{id}/renew	Renew domain
DomainServiceApi	restoreDomain	POST /v1beta/domains/{id}/restore	Restore domain
DomainServiceApi	sendFoa1	POST /v1beta/domains/{id}/transfer/send-foa1	Send foa1
DomainServiceApi	suggestNameDomain	POST /v1beta/domains/suggest-name	Suggest name domain
DomainServiceApi	tradeDomain	POST /v1beta/domains/trade	Trade domain
DomainServiceApi	transferDomain	POST /v1beta/domains/transfer	Transfer domain
DomainServiceApi	tryAgainLastOperation	POST /v1beta/domains/{id}/last-operation/restart	Try again last operation
DomainServiceApi	updateDomain	PUT /v1beta/domains/{id}	Update domain
DomainTokenApi	createToken	POST /v1beta/dns/domain-token	Create token
EasydmarcOrderApi	createEasyDmarc	POST /v1beta/easydmarcs	Create easy dmarc
EasydmarcOrderApi	deleteEasyDmarc	DELETE /v1beta/easydmarcs/{id}	Delete easy dmarc
EasydmarcOrderApi	getEasyDmarc	GET /v1beta/easydmarcs	Get easy dmarc
EasydmarcOrderApi	getEasyDmarcSso	GET /v1beta/easydmarcs/{id}/sso	Get easy dmarc sso
EasydmarcOrderApi	listEasyDmarc	GET /v1beta/easydmarcs/list	List easy dmarc
EasydmarcOrderApi	retryEasyDmarc	POST /v1beta/easydmarcs/{id}/retry	Retry easy dmarc
EmailApi	createEmail	POST /v1beta/emails	Create email
EmailApi	deleteEmail	DELETE /v1beta/emails/{id}	Delete email
EmailApi	listEmails	GET /v1beta/emails	List emails
EmailApi	updateEmail	PUT /v1beta/emails/{id}	Update email
EmailVerificationApi	listDomainEmailVerifications	GET /v1beta/customers/verifications/emails/domains	List domain email verifications
EmailVerificationApi	restartEmailVerification	POST /v1beta/customers/verifications/emails/restart	Restart email verification
EmailVerificationApi	startEmailVerification	POST /v1beta/customers/verifications/emails/start	Start email verification
InvoiceServiceApi	listInvoices	GET /v1beta/invoices	List invoices
LicenseServiceApi	createPleskLicense	POST /v1beta/licenses/plesk	Create plesk license
LicenseServiceApi	createVirtuozzoLicense	POST /v1beta/licenses/virtuozzo	Create virtuozzo license
LicenseServiceApi	deletePleskLicense	DELETE /v1beta/licenses/plesk/{key_id}	Delete plesk license
LicenseServiceApi	deleteVirtuozzoLicense	DELETE /v1beta/licenses/virtuozzo/{key_id}	Delete virtuozzo license
LicenseServiceApi	getPleskKey	GET /v1beta/licenses/plesk/key/{key_id}	Get plesk key
LicenseServiceApi	getPleskLicense	GET /v1beta/licenses/plesk/{key_id}	Get plesk license
LicenseServiceApi	getVirtuozzoKey	GET /v1beta/licenses/virtuozzo/{key_id}/key	Get virtuozzo key
LicenseServiceApi	getVirtuozzoLicense	GET /v1beta/licenses/virtuozzo/{key_id}	Get virtuozzo license
LicenseServiceApi	listItems	GET /v1beta/licenses/items	List items
LicenseServiceApi	listLicensesWithPriceVersion	GET /v1beta/licenses	List licenses with price version
LicenseServiceApi	listPleskLicenses	GET /v1beta/licenses/plesk	List plesk licenses
LicenseServiceApi	listVirtuozzoLicenses	GET /v1beta/licenses/virtuozzo	List virtuozzo licenses
LicenseServiceApi	resetHwid	POST /v1beta/licenses/hwids/reset/{product}/{key_id}	Reset hwid
LicenseServiceApi	updatePleskLicense	PUT /v1beta/licenses/plesk/{key_id}	Update plesk license
LicenseServiceApi	updateVirtuozzoLicense	PUT /v1beta/licenses/virtuozzo/{key_id}	Update virtuozzo license
NameserverServiceApi	createNameserver	POST /v1beta/dns/nameservers	Create nameserver
NameserverServiceApi	deleteNameserver	DELETE /v1beta/dns/nameservers/{name}	Delete nameserver
NameserverServiceApi	getNameserver	GET /v1beta/dns/nameservers/{name}	Get nameserver
NameserverServiceApi	listNameservers	GET /v1beta/dns/nameservers	List nameservers
NameserverServiceApi	updateNameserver	PUT /v1beta/dns/nameservers/{name}	Update nameserver
NsGroupServiceApi	createGroup	POST /v1beta/dns/nameservers/groups	Create group
NsGroupServiceApi	deleteGroup	DELETE /v1beta/dns/nameservers/groups/{ns_group}	Delete group
NsGroupServiceApi	getGroup	GET /v1beta/dns/nameservers/groups/{ns_group}	Get group
NsGroupServiceApi	listGroups	GET /v1beta/dns/nameservers/groups	List groups
NsGroupServiceApi	updateGroup	PUT /v1beta/dns/nameservers/groups/{ns_group}	Update group
OrderApi	cancelOrder	POST /v1beta/ssl/orders/{id}/cancel	Cancel order
OrderApi	createOrder	POST /v1beta/ssl/orders	Create order
OrderApi	getOrder	GET /v1beta/ssl/orders/{id}	Get order
OrderApi	listOrders	GET /v1beta/ssl/orders	List orders
OrderApi	reissueOrder	POST /v1beta/ssl/orders/{id}/reissue	Reissue order
OrderApi	renewOrder	POST /v1beta/ssl/orders/{id}/renew	Renew order
OrderApi	updateOrder	PUT /v1beta/ssl/orders/{id}	Update order
OrderApproverEmailApi	resendApproverEmail	POST /v1beta/ssl/orders/{id}/approver-email/resend	Resend approver email
OrderApproverEmailApi	updateApproverEmailAddress	PUT /v1beta/ssl/orders/{id}/approver-email	Update approver email address
OtpTokenApi	createOtpToken	POST /v1beta/ssl/orders/{id}/otp-tokens	Create otp token
PaymentApi	listPayments	GET /v1beta/payments	List payments
ProductApi	getProduct	GET /v1beta/ssl/products/{id}	Get product
ProductApi	listProducts	GET /v1beta/ssl/products	List products
ResellerServiceApi	getReseller	GET /v1beta/resellers	Get reseller
ResellerServiceApi	updateReseller	PUT /v1beta/resellers/{id}	Update reseller
SEDomainApi	createDomainMixin8	POST /v1beta/spam-expert/domains	Create domain
SEDomainApi	deleteDomainMixin8	DELETE /v1beta/spam-expert/domains/{domain_name}	Delete domain
SEDomainApi	getDomainMixin8	GET /v1beta/spam-expert/domains/{domain_name}	Get domain
SEDomainApi	updateDomainMixin8	PUT /v1beta/spam-expert/domains/{domain_name}	Update domain
SettingsApi	getSettings	GET /v1beta/resellers/settings	Get settings
SpamExpertApi	generateLoginURL	POST /v1beta/spam-expert/generate-login-url	Generate login url
StatisticsApi	getStatistics	GET /v1beta/resellers/statistics	Get statistics
TagServiceApi	createTag	POST /v1beta/tags	Create tag
TagServiceApi	deleteTag	DELETE /v1beta/tags	Delete tag
TagServiceApi	listTags	GET /v1beta/tags	List tags
TemplateServiceApi	createTemplate	POST /v1beta/dns/templates	Create template
TemplateServiceApi	deleteTemplate	DELETE /v1beta/dns/templates/{id}	Delete template
TemplateServiceApi	getTemplate	GET /v1beta/dns/templates/{id}	Get template
TemplateServiceApi	listTemplates	GET /v1beta/dns/templates	List templates
TldServiceApi	getTld	GET /v1beta/tlds/{name}	Get tld
TldServiceApi	listTlds	GET /v1beta/tlds	List tlds
TransactionApi	listTransactions	GET /v1beta/transactions	List transactions
ZoneRecordServiceApi	listZoneRecords	GET /v1beta/dns/zones/{name}/records	List zone records
ZoneServiceApi	createZone	POST /v1beta/dns/zones	Create zone
ZoneServiceApi	deleteZone	DELETE /v1beta/dns/zones/{name}	Delete zone
ZoneServiceApi	getZone	GET /v1beta/dns/zones/{name}	Get zone
ZoneServiceApi	listZones	GET /v1beta/dns/zones	List zones
ZoneServiceApi	updateZone	PUT /v1beta/dns/zones/{name}	Update zone

Models

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0-beta
- Package version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

savvii/openprovider-rest 适用场景与选型建议

savvii/openprovider-rest 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 222 次下载、GitHub Stars 达 2，最近一次更新时间为 2023 年 02 月 09 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「rest」「api」「sdk」「openapi」「openprovider」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 savvii/openprovider-rest 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 savvii/openprovider-rest 我们能提供哪些服务？

定制开发 / 二次开发

基于 savvii/openprovider-rest 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 savvii/openprovider-rest 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

theodorejb/phaster 6

A PSR-7 compatible library for making CRUD API endpoints

braune-digital/api-base-bundle 0

Api bundle

foxtes/alfabank-rest 1

Alfabank REST API integration

intahwebz/flickrguzzle 4

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%).

gego-soft/php-client 0

BlockCypher's PHP SDK for REST API

wellrested/cookies 0

Helper classes for creating cookie headers

savvii/openprovider-rest

包简介

关键字：