cloudmersive/cloudmersive_configuration_api_client

2.0.5 2023-07-01 19:28 UTC

Requires

• php: >=7.2.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.5

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Cloudmersive

• php
• api
• sdk
• swagger

README

Config API lets you easily manage configuration at scale.

Cloudmersive Configuration API provides advanced configuration and orchestration capabilities.

• API version: v1
• Package version: 2.0.5

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cloudmersive/cloudmersive_configuration_api_client.git"
    }
  ],
  "require": {
    "cloudmersive/cloudmersive_configuration_api_client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_configuration_api_client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\OrchestratorApi(
    // 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
);
$request = new \Swagger\Client\Model\HttpOrchestrationRequest(); // \Swagger\Client\Model\HttpOrchestrationRequest | 

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

?>

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
OrchestratorApi	orchestratorHttpSimple	POST /config/orchestrator/http/simple	Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
SettingsApi	settingsCreateSetting	POST /config/settings/create	Create a setting in the specified bucket
SettingsApi	settingsListSettings	POST /config/settings/list	Enumerate the settings in a bucket
SettingsApi	settingsUpdateSetting	POST /config/settings/update	Update a setting

Documentation For Models

• CreateSettingRequest
• CreateSettingResponse
• HttpFormDataParameter
• HttpGetParameter
• HttpOrchestrationHeader
• HttpOrchestrationRequest
• HttpOrchestrationResponse
• HttpOrchestrationTask
• HttpRawBinaryParameter
• HttpRawTextParameter
• HttpWwwFormUrlEncodedParameter
• ListSettingsRequest
• ListSettingsResponse
• SettingValue
• TaskOutputReference
• UpdateSettingRequest
• UpdateSettingResponse

Documentation For Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header

Author