README

OpenAPI Endpoints

<a href="/api-json">OpenAPI Spec in JSON
<a href="/api-yaml">OpenAPI Spec in YAML

Offboarding

Every service conntected to Grünes Netz needs to remove users when they are removed from saml.gruene.de. Connected services need to pull a list of users waiting for removal at least once a week. api.gruene.de needs to be informed whether the user did not exist or was removed. API tokens can be obtained from technik@verdigado.com.

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/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer (JWT) authorization: bearer
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Verdigado\GrueneApiClient\Api\CampaignsApi(
    // 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
);
$poi_id = 'poi_id_example'; // string
$image = "/path/to/file.txt"; // \SplFileObject

try {
    $result = $apiInstance->addPoiPhoto($poi_id, $image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->addPoiPhoto: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.gruene.de

Models

Authorization

basic

Type: HTTP basic authentication

bearer

Type: Bearer authentication (JWT)

api_key

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

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.1.0
- Package version: 0.9.2
Build package: org.openapitools.codegen.languages.PhpClientCodegen

verdigado / gruene-api-client

Maintainers

Details