README

This is the first release of our connected car API. With this API you can access more than 89 signals in a car. This API is available on Peugeot, Citroën and DS cars.

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

API version: 1.0.5
Package version: 1.0.0
Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://developer.psa-peugeot-citroen.com/

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/garygitton/psa-connected-car-sdk-php.git"
    }
  ],
  "require": {
    "garygitton/psa-connected-car-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/psa-connected-car-sdk-php/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: Client ID
$config = Psa\ConnectedCar\Configuration::getDefaultConfiguration()->setApiKey('client_id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Psa\ConnectedCar\Configuration::getDefaultConfiguration()->setApiKeyPrefix('client_id', 'Bearer');

$apiInstance = new Psa\ConnectedCar\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
);
$locale = ""; // string | Locale. For example : fr_FR for french
$brand = ""; // string | Brand of the vehicle : C for Citroën or DS, P for Peugeot

try {
    $result = $apiInstance->fetchAlertReferential($locale, $brand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fetchAlertReferential: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/dev/connectedcar/v1

Class	Method	HTTP request
DefaultApi	fetchAlertReferential	GET /referential/alert
DefaultApi	fetchAllCrash	POST /crash/list
DefaultApi	fetchAllEcodrivingReferential	GET /referential/ecodriving
DefaultApi	fetchAllEcoevaluation	POST /ecodriving/evaluation/list
DefaultApi	fetchAllEcoevaluationPerDay	POST /ecodriving/evaluation/trip/day/list
DefaultApi	fetchAllEcoevaluationPerMonth	POST /ecodriving/evaluation/trip/month/list
DefaultApi	fetchAllEnvironmentData	POST /environment/list
DefaultApi	fetchAllLightStatus	POST /running/lightstatus/list
DefaultApi	fetchAllMaintenanceAlert	POST /maintenance/list/alert
DefaultApi	fetchAllMaintenanceData	POST /maintenance/list
DefaultApi	fetchAllRunningData	POST /running/list
DefaultApi	fetchAllRunningDataByVehicle	GET /running/data/{vin}
DefaultApi	fetchAllTrip	POST /trip/list
DefaultApi	fetchCrashByVehicle	GET /crash/get/{vin}
DefaultApi	fetchEcoevaluationByVehicle	GET /ecodriving/evaluation/get/{vin}
DefaultApi	fetchEcoevaluationByVehicleAndTrip	GET /ecodriving/evaluation/pertrip/{vin}/{tripid}
DefaultApi	fetchEcoevaluationPerDayByVehicle	GET /ecodriving/evaluation/trip/day/{vin}
DefaultApi	fetchEcoevaluationPerDaytripsByVehicle	GET /ecodriving/evaluation/daytrips/{vin}
DefaultApi	fetchEcoevaluationPerMonthByVehicle	GET /ecodriving/evaluation/trip/month/{vin}
DefaultApi	fetchEnvironmentDataByVehicle	GET /environment/get/{vin}
DefaultApi	fetchFuelPriceReferenceByVehicle	GET /trip/get/reference/fuelprice/{vin}
DefaultApi	fetchLastDrivingAssistanceByVehicle	GET /safety/drivingassistance/{vin}
DefaultApi	fetchLastPositionByVehicle	GET /place/lastposition/{vin}
DefaultApi	fetchLastSafetyAssistanceByVehicle	GET /safety/safetyassistance/{vin}
DefaultApi	fetchLastTripEcoevaluationByVehicle	GET /ecodriving/evaluation/lasttrip/{vin}
DefaultApi	fetchLastTripsByVehicle	GET /trip/last/{vin}
DefaultApi	fetchLightStatusByVehicle	GET /running/data/lightstatus/{vin}
DefaultApi	fetchMaintenanceAlertByVehicle	GET /maintenance/alert/{vin}
DefaultApi	fetchMaintenanceDataByVehicle	GET /maintenance/{vin}
DefaultApi	fetchMaintenanceReferential	GET /referential/maintenance
DefaultApi	fetchPictureByVehicleAndContract	POST /vehicle/picture/{vin}/{contract}
DefaultApi	fetchPictureByVehicleAndContract2	GET /vehicle/picture/{vin}/{contract}
DefaultApi	fetchPositionPerTripByVehicle	GET /place/positions/trip/{vin}
DefaultApi	fetchReferenceTripByVehicle	GET /trip/get/referencetrip/{vin}
DefaultApi	fetchTripByVehicleAndTrip	GET /trip/id/{vin}/{tripid}
DefaultApi	fetchTripPerPeridByVehicle	GET /trip/period/{vin}
DefaultApi	fetchVehicleInformationByVehicle	GET /vehicle/information/{vin}
DefaultApi	searchCrashByVehicle	GET /crash/search/{vin}
DefaultApi	searchDrivingAssistancePerDayByVehicle	GET /safety/search/drivingassistance/day/{vin}
DefaultApi	searchSafetyAssistancePerDayByVehicle	GET /safety/search/safetyassistance/day/{vin}
DefaultApi	updateFuelPriceForTripByVehicleAndTrip	PUT /trip/update/fuelprice/{vin}/{tripid}
DefaultApi	updateFuelPriceReferenceByVehicle	PUT /trip/update/reference/fuelprice/{vin}
DefaultApi	updateReferenceTripByVehicle	PUT /trip/update/referencetrip/{vin}

Documentation For Models

Documentation For Authorization

Client ID

Type: API key
API key parameter name: client_id
Location: URL query string

Author

connectedcar@mpsa.com

garygitton / psa-connected-car-sdk-php

Maintainers

Details