Skip to content
This repository was archived by the owner on Oct 12, 2026. It is now read-only.

Latest commit

 

History

History
164 lines (115 loc) · 3.96 KB

README.md

File metadata and controls

164 lines (115 loc) · 3.96 KB

simplycom/api-php

Warning

This repository is archived and no longer maintained. Use the Simply.com REST API directly.

Official PHP client for the Simply.com API.

Requirements

PHP 8.1 or higher.

Installation

composer require simplycom/php-sdk

Quickstart

<?php

require __DIR__ . '/vendor/autoload.php';

use SimplyCom\Client;

$simply = new Client('your-api-key');

$products = $simply->products()->getProductList();

foreach ($products->getProducts() as $product) {
    echo $product->getObject() . PHP_EOL;
}

The API key alone identifies the account, and is sent as a Bearer token. See API authentication.

Available resources

Each API tag in the OpenAPI specification is exposed as a method on Client:

$simply->accounts()     // getAccountList
$simply->billing()      // getInvoices
$simply->database()     // getMysqlDatabases
$simply->dnszone()      // addDnsRecord, ddnsHelper, deleteDnsRecord, dyndns, getDnsRecords, getDnsZone, reloadDnsZone, updateDnsRecord
$simply->domains()      // domaincheck
$simply->logs()         // getFirewallLogs
$simply->mail()         // addMailAccount, addMailForward, getMailAccounts, getMailForwards
$simply->order()        // createOrder, getOrderableProducts, orderDnsService
$simply->products()     // getProductList
$simply->registry()     // addDnssecKey, getDnssecKeys, getNameservers, removeDnssec, setNameservers
$simply->serverstatus() // getServerStatusMessages
$simply->subdomains()   // getSubdomains
$simply->urlforwards()  // addUrlForward, deleteUrlForward, getUrlForwards

Examples

List DNS records

use SimplyCom\Client;

$simply = new Client('your-api-key');

$response = $simply->dnszone()->getDnsRecords('example.com');

foreach ($response->getRecords() as $record) {
    printf("%-6s %-30s %s\n", $record->getType(), $record->getName(), $record->getData());
}

Add a DNS record

use SimplyCom\Client;
use SimplyCom\Model\DnsRecordPayload;
use SimplyCom\Model\DnsRecordType;

$simply = new Client('your-api-key');

$payload = new DnsRecordPayload([
    'type' => DnsRecordType::A,
    'name' => 'www',
    'data' => '1.2.3.4',
    'ttl'  => 3600,
]);

$result = $simply->dnszone()->addDnsRecord('example.com', $payload);

echo 'Created record id ' . $result->getRecord()->getId() . PHP_EOL;

Check domain availability

use SimplyCom\Client;

$simply = new Client('your-api-key');

$check = $simply->domains()->domaincheck('example.com')->getDomain();

if ($check->getAvailable()) {
    echo 'Available!' . PHP_EOL;
} elseif ($check->getCantransfer()) {
    echo 'Taken, but can be transferred.' . PHP_EOL;
} else {
    echo 'Taken.' . PHP_EOL;
}

List invoices

use SimplyCom\Client;

$simply = new Client('your-api-key');

foreach ($simply->billing()->getInvoices()->getInvoices() as $invoice) {
    printf("%s  %s %s  %s\n",
        $invoice->getDate(),
        number_format($invoice->getAmount(), 2),
        $invoice->getCurrency(),
        $invoice->getSubject(),
    );
}

Error handling

API errors are thrown as SimplyCom\ApiException. The exception exposes the HTTP status code, response body, and response headers.

use SimplyCom\Client;
use SimplyCom\ApiException;

$simply = new Client('your-api-key');

try {
    $simply->dnszone()->getDnsRecords('not-your-domain.com');
} catch (ApiException $e) {
    echo $e->getCode() . ': ' . $e->getMessage() . PHP_EOL;
    echo $e->getResponseBody();
}

Custom HTTP client

Pass any GuzzleHttp\ClientInterface to the Client constructor, e.g. to set a custom timeout, proxy, or handler stack:

use GuzzleHttp\Client as Guzzle;
use SimplyCom\Client;

$http = new Guzzle(['timeout' => 10.0]);
$simply = new Client('your-api-key', $http);

License

See LICENSE.