brightwrite/brightwrite-php-sdk

PHP client for BrightWrite API


Keywords
php, api, sdk, swagger
License
MIT

Documentation

BrightWrite

BrightWrite API

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

  • API version: 0.1.7
  • Package version: 1.0.13
  • Build date: 2018-03-26T00:20:23.932Z
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/brightwrite/brightwrite-php-sdk.git"
    }
  ],
  "require": {
    "brightwrite/brightwrite-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/BrightWrite/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: apiKeyHeader
BrightWrite\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// BrightWrite\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'BEARER');

$api_instance = new BrightWrite\Api\DefaultApi();

try {
    $api_instance->brightwriteControllerStatus();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->brightwriteControllerStatus: ', $e->getMessage(), "\n";
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.brightwrite.com/api/v1

Class Method HTTP request Description
DefaultApi brightwriteControllerStatus GET /status Health check endpoint
PartnerApi brightwriteControllerPricingRequestCarRentalAction POST /pricingRequestCarRental Pricing request for a car rental policy
PartnerApi brightwriteControllerQuoteConversionAction PUT /quoteConversion Pricing request for car rental business

Documentation For Models

Documentation For Authorization

apiKeyHeader

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author