Skip to content

README.md

Latest commit

 

History

History
120 lines (81 loc) · 2.81 KB

README.md

File metadata and controls

120 lines (81 loc) · 2.81 KB

Databox

Push API resources Open API documentation

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Databox/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 = Databox\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Databox\Api\DefaultApi(
    // 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 {
    $apiInstance->dataDelete();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->dataDelete: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://push.databox.com

Class Method HTTP request Description
DefaultApi dataDelete DELETE /data
DefaultApi dataMetricKeyDelete DELETE /data/{metricKey}
DefaultApi dataPost POST /data
DefaultApi metrickeysGet GET /metrickeys
DefaultApi metrickeysPost POST /metrickeys
DefaultApi pingGet GET /ping

Models

Authorization

Authentication schemes defined for the API:

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: 0.3.15-sdk.6
    • Package version: 2.2.0
    • Generator version: 7.6.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen