pitchero / reseller-club

ResellerClub API 的 PHP SDK。

维护者

详细信息

github.com/Pitchero/ResellerClub

安装次数: 14,214

开放问题: 6

1.9.0 2022-06-20 13:00 UTC

Requires

php: >=7.0.0
guzzlehttp/guzzle: ~6.0
moneyphp/money: ~3.0
nesbot/carbon: ~1.20 || ~2.0

Requires (Dev)

phpunit/phpunit: ^6.4 || ^8.0
symfony/var-dumper: ^3.3

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT fc9652043fd99e2b020574b5fd907a6dafaf234b

Robert Rosebury <r.rosebury.woop@pitchero.com>
Martin Bean <m.bean.woop@pitchero.com>

api email hosting reseller-club resellerclub

This package is auto-updated.

Last update: 2024-09-20 18:03:15 UTC

README

ResellerClub API 的 PHP SDK。

要求

PHP >= 7.0

安装

此包通过 Packagist 提供。要使用 Composer 安装到项目中

$ composer require pitchero/reseller-club

示例用法

商业电子邮件

创建订单

try {
    $api = new ResellerClub\Api(
         new ResellerClub\Config(123, 'api_key', true),
         new GuzzleHttp\Client()
    )

    $request = new ResellerClub\Orders\BusinessEmails\Requests\BusinessEmailOrderRequest(
        $customerId = 123,
        $domain = 'some-domain.co.uk',
        $numberOfAccount = 5,
        $forNumberOfMonths = 1,
        ResellerClub\Orders\InvoiceOption::noInvoice()
    );    

    $response = $api->businessEmailOrder()->create($request);

    // @todo - Handle a successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

删除订单

try {
    $api = new ResellerClub\Api(
         new ResellerClub\Config(123, 'api_key', true),
         new GuzzleHttp\Client()
    );

    $request = new ResellerClub\Orders\Order(
        $orderId = 123
    );

    $response = $api->businessEmailOrder()->delete($request);

    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

获取订单

try {
    $api = new ResellerClub\Api(
         new ResellerClub\Config(123, 'api_key', true),
         new GuzzleHttp\Client()
    );

    $request = new ResellerClub\Orders\Order(
        $orderId = 123
    );   

    $response = $api->businessEmailOrder()->get($request);

    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

续订订单

try {
    $api = new ResellerClub\Api(
         new ResellerClub\Config(123, 'api_key', true),
         new GuzzleHttp\Client()
    );

    $request = new ResellerClub\Orders\BusinessEmails\Requests\RenewRequest(
        new ResellerClub\Orders\Order(
           $orderId = 123
        ),
        $months = 1,
        $numberOfAccounts = 1,
        ResellerClub\Orders\InvoiceOption::noInvoice()
    );

    $response = $api->businessEmailOrder()->renew($request);

    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

将电子邮件帐户添加到商业电子邮件订单

try {
    $api = new ResellerClub\Api(
         new ResellerClub\Config(123, 'api_key', true),
         new GuzzleHttp\Client()
    );

    $request = new ResellerClub\Orders\BusinessEmails\Requests\AddEmailAccountRequest(
        new ResellerClub\Orders\Order(
           $orderId = 123
        ),
        $numberOfAccounts = 1,
        ResellerClub\Orders\InvoiceOption::noInvoice()
    );

    $response = $api->businessEmailOrder()->addEmailAccounts($request);

    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

从现有的商业电子邮件订单中删除电子邮件帐户

try {
    $api = new ResellerClub\Api(
         new ResellerClub\Config(123, 'api_key', true),
         new GuzzleHttp\Client()
    );

    $request = new ResellerClub\Orders\BusinessEmails\Requests\DeleteEmailAccountRequest(
        new ResellerClub\Orders\Order(
           $orderId = 123
        ),
        $numberOfAccounts = 1
    );

    $response = $api->businessEmailOrder()->deleteEmailAccounts($request);
        
    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

电子邮件帐户

创建电子邮件帐户

try {
        $api = new ResellerClub\Api(
             new ResellerClub\Config(123, 'api_key', true),
             new GuzzleHttp\Client()
        );

        $request = ResellerClub\Orders\EmailAccounts\Requests\CreateRequest(
            ResellerClub\Orders\Order(
               $orderId = 123
            ),
            ResellerClub\EmailAddress(
               $email = 'john.doe@some-domain.co.uk'
            ),
            string $password,
            ResellerClub\EmailAddress(
               $notificationsEmail = 'john.doe@backup-email.co.uk'
            ),
            $firstName = 'John',
            $lastName = 'Doe',
            $countryCode = 'UK',
            $languageCode = 'en'
        );

        $response = $api->emailAccount()->create($request);

        // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

删除电子邮件帐户

try {
        $api = new ResellerClub\Api(
             new ResellerClub\Config(123, 'api_key', true),
             new GuzzleHttp\Client()
        );

        $request = ResellerClub\Orders\EmailAccounts\Requests\DeleteRequest(
            ResellerClub\Orders\Order(
                $orderId = 123
            ),   
            ResellerClub\EmailAddress(
                $email = 'john.doe@some-domain.co.uk'
            )                     
        );

        $response = $api->emailAccount()->delete($request);

        // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

电子邮件转发

创建电子邮件转发

try {
        $api = new ResellerClub\Api(
             new ResellerClub\Config(123, 'api_key', true),
             new GuzzleHttp\Client()
        );

        $request = ResellerClub\Orders\EmailForwarders\Requests\CreateRequest(
              ResellerClub\Orders\Order(
                 $orderId = 123
              ),   
              ResellerClub\EmailAddress(
                $email = 'john.doe@some-domain.co.uk'
              )                   
        );

        $response = $api->emailForwarder()->create($request);

        // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

删除电子邮件转发

try {
        $api = new ResellerClub\Api(
             new ResellerClub\Config(123, 'api_key', true),
             new GuzzleHttp\Client()
        );

        $request = ResellerClub\Orders\EmailAccounts\Requests\DeleteRequest(
            ResellerClub\Orders\Order(
                $orderId = 123
            ),   
            ResellerClub\EmailAddress(
                $email = 'john.doe@some-domain.co.uk'
            )                      
        );

        $response = $api->emailForwarder()->delete($request);

        // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

来自 ResellerClub 知识库的有用文章

添加 A 记录

try {
    $ttl = new ResellerClub\TimeToLive(86400);
    $request = new ResellerClub\Dns\A\Requests\AddRequest(
        $domain = 'another-testing-domain.com',
        $record = 'test',
        new ResellerClub\IPv4Address('127.0.0.1'),
        $ttl
    );

    $response = $api->aRecord()->add($request);

    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

更新 CNAME 记录

try {
    $ttl = new ResellerClub\TimeToLive(86400);
    $request = new ResellerClub\Dns\Cname\Requests\UpdateRequest(
        $domain = 'your.com',
        $record = 'www',
        $currentValue = 'cname.oldservice.com',
        $newValue = 'cname.newservice.com',
        $ttl
    );

    $response = $api->cnameRecord()->update($request);

    // @todo - Handle the successful response within your codebase.

} catch(ResellerClub\Exceptions\ApiException $e) {
    // @todo - Handle the exception within your codebase.
}

许可

在 MIT 许可证下许可。

问题

如果您发现此包有任何问题，请打开 GitHub Issue。