ProvisioningDownloadsApi.md

Yoast\MyYoastApiClient\ProvisioningDownloadsApi

All URIs are relative to https://my.yoast.test

Method	HTTP request	Description
currentVersion	GET /api/provisioning/downloads/currentVersion	Retrieve the current version for the productCode for the provisioner.
currentVersionV2	GET /api/v2/provisioning/downloads/currentVersion	Get current version of downloads for a product.
currentZip	GET /api/provisioning/downloads/currentZip	Redirect to the current zip for the productCode.

currentVersion

string currentVersion($productCode)

Retrieve the current version for the productCode for the provisioner.

This route returns the latest version of the product that is offered to the customer when using the passed productCode.

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\ProvisioningDownloadsApi(
    // 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()
);
$productCode = "productCode_example"; // string | The code used to create the product.

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

Parameters

Name	Type	Description	Notes
productCode	string	The code used to create the product.

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

currentVersionV2

\Yoast\MyYoastApiClient\Model\ProductVersionsDto currentVersionV2($productCode)

Get current version of downloads for a product.

This route returns the version numbers and the download URLs of the latest versions of the available downloads for a product

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\ProvisioningDownloadsApi(
    // 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()
);
$productCode = "productCode_example"; // string | The code used to create the product.

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

Parameters

Name	Type	Description	Notes
productCode	string	The code used to create the product.

Return type

\Yoast\MyYoastApiClient\Model\ProductVersionsDto

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

currentZip

currentZip($productCode)

Redirect to the current zip for the productCode.

If a new version is available, you can use this route to redirect to the zip of that new version of the product.

Example

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

$apiInstance = new Yoast\MyYoastApiClient\Api\ProvisioningDownloadsApi(
    // 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()
);
$productCode = "productCode_example"; // string | The code used to create the product.

try {
    $apiInstance->currentZip($productCode);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningDownloadsApi->currentZip: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
productCode	string	The code used to create the product.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]