SimplyCom-php

Documentation for this API can be found on https://www.simply.com/docs/api/

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/simplycom/api-php.git"
    }
  ],
  "require": {
    "simplycom/api-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/SimplyCom-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: basicAuth
$config = SimplyCom\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SimplyCom\Api\BillingApi(
    // 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
);

try {
    $result = $apiInstance->getInvoices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingApi->getInvoices: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.simply.com/2

Class	Method	HTTP request	Description
BillingApi	getInvoices	GET /my/invoices/	Retrieve list of invoices
DnsApi	addDnsRecord	POST /my/products/{object}/dns/records/	Add new DNS record to a product DNS zone
DnsApi	ddnsHelper	GET /ddns/	Dynamic DNS helper endpoint
DnsApi	deleteDnsRecord	DELETE /my/products/{object}/dns/records/{record_id}/	Remove DNS record from a product DNS zone
DnsApi	dyndns	GET /dyndns/	DynDNS protocol-compatible endpoint
DnsApi	getDnsRecords	GET /my/products/{object}/dns/records/	Retrieve all DNS records for a product
DnsApi	getDnsZone	GET /my/products/{object}/dns/	Retrieve DNS zone metadata
DnsApi	reloadDnsZone	POST /my/products/{object}/dns/reload/	Force-reload a DNS zone
DnsApi	updateDnsRecord	PUT /my/products/{object}/dns/records/{record_id}/	Update a DNS record in a product DNS zone
DocumentationApi	call256e4ac7a9c56843cf5ae63394373a90	GET /openapi.json	OpenAPI JSON file that describes the API
DomainsApi	domaincheck	GET /my/domaincheck/{domain}/	Check domain availability
MailApi	addMailAccount	POST /my/products/{object}/mail/accounts/	Add new mail account to a product
OrderApi	orderDnsService	POST /my/order/dnsservice/	Order a DNS service with optional domain registration/transfer
ProductsApi	getProductList	GET /my/products/	Retrieve list of products
ServerstatusApi	getServerStatusMessages	GET /my/serverstatus/messages/	Retrieve server status messages

Models

• AddDnsRecord200Response
• AddDnsRecord200ResponseRecord
• AddDnsRecord400Response
• AddDnsRecordRequest
• AddMailAccount400Response
• AddMailAccountRequest
• Domaincheck200Response
• Domaincheck200ResponseDomain
• GetDnsRecords200Response
• GetDnsRecords200ResponseRecordsInner
• GetDnsRecords404Response
• GetDnsZone200Response
• GetDnsZone200ResponseZone
• GetInvoices200Response
• GetInvoices200ResponseInvoicesInner
• GetProductList200Response
• GetProductList200ResponseProductsInner
• GetProductList200ResponseProductsInnerDomain
• GetProductList200ResponseProductsInnerProduct
• GetProductList200ResponseProductsInnerServers
• GetProductList200ResponseProductsInnerServersWebserver
• GetProductList200ResponseProductsInnerUsernames
• GetServerStatusMessages200Response
• GetServerStatusMessages200ResponseMessagesInner
• OrderDnsService200Response
• OrderDnsService200ResponseOrder
• OrderDnsService400Response
• OrderDnsServiceRequest
• UpdateDnsRecord200Response
• UpdateDnsRecordRequest

Authorization

basicAuth

• Type: HTTP basic 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: 2.2.1
  • Generator version: 7.20.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen