WP Engine PHP API Client Documentation

Introduction¶

The Tectalic WP Engine REST API Client is a package that provides a convenient and straightforward way to interact with the WP Engine API from your PHP application.

You can purchase this package from https://tectalic.com/apis/wp-engine.

Installation¶

System Requirements¶

• PHP version 7.2.5 or newer (including PHP 8.0 and 8.1)
• PHP JSON extension installed if using PHP 7.x. As of PHP 8.0, this extension became a core PHP extension so is always enabled.
• A PSR-18 compatible HTTP client such as ‘Guzzle’ or the ‘Symfony HTTP Client’.

Composer Installation¶

To install this package into your PHP project, we recommend using Composer.

Please see the detailed instructions on configuring your project to access the Tectalic Composer repository.

You will need to log into the Tectalic account that purchased the Tectalic WP Engine REST API Client package to access these instructions.

Once you have followed the above instructions, install the package into your project:

composer require tectalic/wp-engine

Manual Installation¶

If you aren’t using Composer in your PHP project, you can choose to Download the latest release and install it into your PHP project manually.

If doing this, you will need to ensure that all dependencies listed in the package’s composer.json file are also installed.

Usage¶

After installing the Tectalic WP Engine REST API Client package into your project, ensure you also have a compatible PSR-18 HTTP client such as ‘Guzzle’ or the Symfony ‘HTTP Client’.

You can use the following code sample and customize it to suit your application.

// Load your project's composer autoloader (if you aren't already doing so).
require_once(__DIR__ . '/vendor/autoload.php');

use Symfony\Component\HttpClient\Psr18Client;
use Tectalic\WpEngine\Authentication;
use Tectalic\WpEngine\Client;
use Tectalic\WpEngine\Manager;
 
// Build a Tectalic WP Engine REST API Client globally.
$auth = new Authentication('username', 'password');
$httpClient = new Psr18Client();
Manager::build($httpClient, $auth);
 
// or
 
// Build a Tectalic WP Engine REST API Client manually.
$auth = new Authentication('username', 'password');
$httpClient = new Psr18Client();
$client = new Client($httpClient, $auth, Manager::BASE_URI);

Authentication¶

To authenticate your API requests, you will need to provide an Authentication ($auth) object when calling Manager::build().

Authentication to the WP Engine API is by HTTP Basic authentication.

API username and password from Portal’s API Access page: https://my.wpengine.com/api_access

Please see the WP Engine API documentation for more details on obtaining your authentication credentials.

In the Usage code above, customize the Authentication constructor to your needs. For example, you may wish to define your credentials in an environment variable and pass it to the constructor.

Client Class¶

The primary class you will interact with is the Client class (Tectalic\WpEngine\Client).

This Client class also contains the helper methods that let you quickly access the 12 API Handlers.

Please see below for a complete list of supported handlers and methods.

Supported API Handlers and Methods¶

This package supports 32 API Methods, which are grouped into 12 API Handlers.

See the table below for a full list of API Handlers and Methods.

API Handler Class and Method Name	Description	API Verb and URL
Accounts::list()	List your WP Engine accounts	GET /accounts
Accounts::get()	Get an account by ID	GET /accounts/{account_id}
AccountsAccountUsers::list()	List your account users	GET /accounts/{account_id}/account_users
AccountsAccountUsers::create()	Create a new account user	POST /accounts/{account_id}/account_users
AccountsAccountUsers::get()	Get an account user by ID	GET /accounts/{account_id}/account_users/{user_id}
AccountsAccountUsers::delete()	Delete an account user	DELETE /accounts/{account_id}/account_users/{user_id}
AccountsAccountUsers::update()	Update an account user	PATCH /accounts/{account_id}/account_users/{user_id}
Installs::list()	List your WordPress installations	GET /installs
Installs::create()	Create a new WordPress installation	POST /installs
Installs::get()	Get an install by ID	GET /installs/{install_id}
Installs::delete()	Delete an install by ID	DELETE /installs/{install_id}
Installs::update()	Update a WordPress installation	PATCH /installs/{install_id}
InstallsBackups::create()	Requests a new backup of a WordPress installation	POST /installs/{install_id}/backups
InstallsBackups::show()	Retreives the status of a backup of a WordPress installation	GET /installs/{install_id}/backups/{backup_id}
InstallsDomains::list()	Get the domains for an install by install id	GET /installs/{install_id}/domains
InstallsDomains::create()	Add a new domain to an existing install	POST /installs/{install_id}/domains
InstallsDomains::get()	Get a specific domain for an install	GET /installs/{install_id}/domains/{domain_id}
InstallsDomains::delete()	Delete a specific domain for an install	DELETE /installs/{install_id}/domains/{domain_id}
InstallsDomains::update()	Set an existing domain as primary	PATCH /installs/{install_id}/domains/{domain_id}
InstallsDomainsCheckStatus::checkStatus()	Check the status of a domain	POST /installs/{install_id}/domains/{domain_id}/check_status
InstallsPurgeCache::purgeCache()	Purge an install’s cache	POST /installs/{install_id}/purge_cache
Sites::list()	List your sites	GET /sites
Sites::create()	Create a new site	POST /sites
Sites::get()	Get a site by ID	GET /sites/{site_id}
Sites::delete()	Delete a site	DELETE /sites/{site_id}
Sites::update()	Change a site name	PATCH /sites/{site_id}
SshKeys::list()	Get your SSH keys	GET /ssh_keys
SshKeys::create()	Add a new SSH key	POST /ssh_keys
SshKeys::delete()	Delete an existing SSH key	DELETE /ssh_keys/{ssh_key_id}
Status::status()	The status of the WP Engine Public API	GET /status
Swagger::swagger()	The current swagger specification	GET /swagger
User::getCurrent()	Get the current user	GET /user

Making a Request¶

There are two ways to make a request to the nominated API Handler and API Method:

If you built the client to be accessible globally, you can use the relevant API Handler Class directly:

use Tectalic\WpEngine\Handlers\Accounts;
 
(new Accounts())->list();

Alternatively, you can access all API Handlers from the client class using the Client class:

$client->accounts()->list();

Retrieving the Response¶

Once you have made a request using one of the two methods outlined above, the next step is to access the response.

You can access the response in different ways. Please choose your preferred one.

Model Responses¶

Model responses are Data Transfer Object (DTO) style PHP classes, with public properties for each API property.

They offer a structured way of retrieving the response from an API request.

All Response Models are an instance of Tectalic\WpEngine\Models\AbstractModel or Tectalic\WpEngine\Models\AbstractModelCollection.

After performing the request, use the ->toModel() fluent method to the API Method:

use Tectalic\WpEngine\Handlers\Accounts;
 
$model = (new Accounts())->list()->toModel();

Each API Method’s toModel() call will return the appropriate Model class type for the API Method you have just called.

Associative Array Responses¶

After performing the request, use the ->toArray() fluent method to the API Method:

use Tectalic\WpEngine\Handlers\Accounts;
 
$array = (new Accounts())->list()->toArray();

In the resulting associative array, the array keys will match the names of the public properties in the relevant Model class.

PSR 7 Response Objects¶

If you need to access the raw response or inspect the HTTP headers, use the ->getResponse() fluent method to the API Method. It will return a Psr\Http\Message\ResponseInterface:

use Tectalic\WpEngine\Handlers\Accounts;
 
$response = (new Accounts())->list()->getResponse();

Errors¶

When performing requests with Tectalic WP Engine REST API Client, specific scenarios will cause a Tectalic\WpEngine\Exception\ClientException to be thrown. Please see below for details.

Invalid Usage of the Manager Class¶

A \LogicException will be thrown if the Manager::build() function is called multiple times, or if Manager::access() is called before calling Manager::build().

Unsuccessful HTTP Response Codes¶

The Tectalic WP Engine REST API Client depends on a PSR-18 compatible HTTP client, and that HTTP client should not throw an exception for unsuccessful HTTP response codes.

An unsuccessful response code is classified as one that is not in the range 200-299 (inclusive). Examples of unsuccessful response codes include:

• Informational responses (100-199)
• Redirection responses (300-399)
• Client error responses (400-499)
• Server error responses (500-599)

If an unsuccessful response code does occur:

• your HTTP Client will not throw an Exception.
• the API Handler’s toModel() method will throw a ClientException.
• the API Handler’s toArray() method will return the response body and not throw a ClientException.
• The API Handler’s getResponse() method will return the raw response and not throw a ClientException.

Below is an example of how you may wish to use a try/catch block when performing a request so that you can detect and handle unexpected errors.

use Tectalic\WpEngine\Authentication;
use Tectalic\WpEngine\Client;
use Tectalic\WpEngine\ClientException;
use Tectalic\WpEngine\Manager;
 
// Build a Tectalic WP Engine REST API Client globally.
$auth = new Authentication('username', 'password');
Manager::build($httpClient, $auth);
$handler = new Accounts();
 
// Perform a request
try {
    $model = $handler->list()->toModel();
    // Do something with the response model...
} catch (ClientException $e) {
    // Error response received. Retrieve the HTTP response code and response body.
    $responseBody = $handler->toArray();
    $rawResponse  = $handler->getResponse()->getResponse();
    $responseCode = $handler->getResponse()->getStatusCode();
    // Handle the error...
}

HTTP Client Exceptions¶

If your HTTP client of choice throws an exception other than ClientException, the Tectalic WP Engine REST API Client Client and its API Handler classes will let these exceptions bubble up.

Consult your HTTP client’s documentation for more details on exception handling.

Tests¶

The Tectalic WP Engine REST API Client package includes several types of automated PHPUnit tests to verify the correct operation:

• Unit Tests
• Integration Tests

To run these tests, you will need to have installed the Tectalic WP Engine REST API Client package with its dev dependencies (i.e. not using the --no-dev flag when running composer).

Unit Tests¶

These PHPUnit tests are designed to:

• confirm that each API Method assembles a valid request that matches the WP Engine API OpenAPI specification.
• verify the behaviour of other parts of the package, such as the Client and Manager classes.

The unit tests can be run using the following command, which needs to be run from this package’s root directory.

composer test:unit

Unit tests do not perform any real requests against the WP Engine API.

Unit tests are located in the tests/Unit directory.

Integration Tests¶

Integration tests are located in the tests/Integration directory.

These PHPUnit tests are designed to confirm that each API Method parses a valid response, according to the WP Engine API OpenAPI specification. Out of the box the integration tests are designed to work with the Prism Mock Server.

Using Prism as the Target¶

Make sure Prism is installed. Please see the Prism documentation for details on how to install Prism.

Once Prism is installed, you can run prism and the integration tests side by side in separate terminal windows, or using the following command, which need to be run from this package’s root directory.

echo "> Starting Prism server"
prism mock tests/openapi.yaml >/dev/null 2>&1 &
PRISM_PID=$!
sleep 2
echo "  => Started"
composer test:integration
kill $PRISM_PID

Those commands will start the Prism mock server, then run the integration tests, and then stop the Prism mock server when the tests are completed.

In this case the integration tests do not perform any real requests against the WP Engine API.

Using a Different Target¶

By setting the WP_ENGINE_CLIENT_TEST_BASE_URI environment variable, you can set a different API endpoint target for the integration tests.

For example, instead of using Prism, you can use a different mocking/staging/test server of your choice, or you can use the WP Engine API’s live endpoints.

Do not forget to set the appropriate credentials in the WP_ENGINE_CLIENT_TEST_AUTH_USERNAME WP_ENGINE_CLIENT_TEST_AUTH_PASSWORD environment variables.

After your setup is complete simply run the following command.

composer test:integration

We do not recommend running integration tests against the live WP Engine API endpoints. This is because the tests will send example data to all endpoints, which can result in new data being created, or existing data being deleted.

Writing Your Own Tests¶

If you are writing your own tests, you will likely need to mock the responses from the WP Engine API.

One way of doing this is to install the php-http/mock-client package into your project, and then use the \Http\Mock\Client class (instead of a real PSR-18 client) when instantiating the Tectalic WP Engine REST API Client.

This allows you to mock the responses from the WP Engine API, rather than performing real requests.

Please see the Mock Client documentation for details.

Support¶

If you have any questions or feedback, you can submit a support request to the Tectalic developers by going to https://tectalic.com/support/wp-engine.

License¶

This software is copyright (c) 2022 Tectalic.

For copyright and license information, please view https://tectalic.com/terms.