Skip to content

Latest commit

 

History

History
124 lines (86 loc) · 3.25 KB

README.md

File metadata and controls

124 lines (86 loc) · 3.25 KB
Raw

ngp-php-api

TODO: Add Description

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

  • API version: 1.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

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/telluric/ngp-api.git"
    }
  ],
  "require": {
    "telluric/ngp-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/ngp-php-api/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 HTTP basic authorization: auth
$config = NGP\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new NGP\Api\MiscApi(
    // 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
);
$content_type = "content_type_example"; // string | 
$body = new \NGP\Model\HelloworldRequest(); // \NGP\Model\HelloworldRequest | 

try {
    $apiInstance->echoesPost($content_type, $body);
} catch (Exception $e) {
    echo 'Exception when calling MiscApi->echoesPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.securevan.com/v4

Class Method HTTP request Description
MiscApi echoesPost POST /echoes Hello world
MiscApi events4306Get GET /events/4306 Get event details
MiscApi people100879417CanvassResponsesPost POST /people/100879417/canvassResponses Collect canvass data
MiscApi peopleFindOrCreatePost POST /people/findOrCreate Create a volunteer record
MiscApi signupsPost POST /signups RSVP to an event

Documentation For Models

Documentation For Authorization

auth

  • Type: HTTP basic authentication

Author