php-client

API for VATSIM. This API only accepts and returns application/json - e-mail api@vatsim.net for troubleshooting

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

• API version: v1
• Package version: 2.3
• 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/zseartcc/vatsim-php-client.git"
    }
  ],
  "require": {
    "zseartcc/vatsim-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

$apiInstance = new VATSIM\Client\Api\DivisionsApi(
    // 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 {
    $result = $apiInstance->divisionsList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DivisionsApi->divisionsList: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.vatsim.net/api

Class	Method	HTTP request	Description
DivisionsApi	divisionsList	GET /divisions/
DivisionsApi	divisionsMembers	GET /divisions/{id}/members/
DivisionsApi	divisionsRead	GET /divisions/{id}/
MapDataApi	mapDataList	GET /map_data/
RatingsApi	ratingsAddComment	POST /ratings/add_comment/	Append a comment to the members profile.
RatingsApi	ratingsConnectionsRead	GET /ratings/{idnum}/connections/
RatingsApi	ratingsFlightPlans	GET /ratings/{idnum}/flight_plans/
RatingsApi	ratingsPartialUpdate	PATCH /ratings/{idnum}/
RatingsApi	ratingsRatingTimes	GET /ratings/{idnum}/rating_times/
RatingsApi	ratingsRead	GET /ratings/{idnum}/
RatingsApi	ratingsRead_0	GET /ratings/{idnum}/atcsessions{var}/
RegionsApi	regionsList	GET /regions/
RegionsApi	regionsMembers	GET /regions/{id}/members/
RegionsApi	regionsRead	GET /regions/{id}/
SubdivisionsApi	subdivisionsList	GET /subdivisions/
SubdivisionsApi	subdivisionsMembers	GET /subdivisions/{id}/members/
SubdivisionsApi	subdivisionsRead	GET /subdivisions/{id}/

Documentation For Models

• ATCSessions
• DivisionPatch
• Divisions
• MapData
• Subdivisions
• User

Documentation For Authorization

Token

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

Author

api@vatsim.net