The VisWiz.io PHP SDK
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib
test
.php_cs
.travis.yml
README.md
composer.json
phpunit.xml.dist

README.md

VisWiz.io PHP SDK

The SDK allows you to query and create new projects, builds or images within the VisWiz service.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

For more information, please visit https://www.viswiz.io

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/viswiz-io/viswiz-php-sdk.git"
    }
  ],
  "require": {
    "viswiz-io/viswiz-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/VisWizSDK/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: api_key
$config = VisWiz\SDK\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
$config = VisWiz\SDK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api = new VisWiz\SDK\Client\ProjectsApi(null, $config);

try {
  $response = $api->getProjects();
} catch (Exception $e) {
  echo 'Exception when calling ProjectsApi->getProjects: ', $e->getMessage(), PHP_EOL;
}

Documentation for API Endpoints

All URIs are relative to https://api.viswiz.io

Class Method HTTP request Description
AccountApi createWebhook POST /webhooks Create a new webhook
AccountApi getAccount GET /account Get account info
AccountApi getWebhooks GET /webhooks Get all webhooks
BuildsApi createBuild POST /projects/{projectID}/builds Create a build
BuildsApi finishBuild POST /builds/{buildID}/finish Finish a build
BuildsApi getBuildResults GET /builds/{buildID}/results Get results for a build
BuildsApi getBuilds GET /projects/{projectID}/builds Get builds for a project
ImagesApi createImage POST /builds/{buildID}/images Create an image
ImagesApi getImages GET /builds/{buildID}/images Get images for a build
PlansApi cancelPlan DELETE /account/cancel-plan Cancel the active plan
PlansApi getPlans GET /plans Get all plans
ProjectsApi createProject POST /projects Create a project
ProjectsApi getProjectNotifications GET /projects/{projectID}/notifications Get notifications settings
ProjectsApi getProjects GET /projects Get all projects
ProjectsApi updateProjectNotifications PUT /projects/{projectID}/notifications Update notifications settings

Documentation For Models

Documentation For Authorization

api_key

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

Author

support@viswiz.io