Download the PHP package verdigado/gruene-api-client without Composer

On this page you can find all versions of the php package verdigado/gruene-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package gruene-api-client

OpenAPIClient-php

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 [email protected].

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:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

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

Class Method HTTP request Description
CampaignsApi addPoiPhoto POST /v1/campaigns/pois/{poiId}/photos Add POI photo
CampaignsApi createArea POST /v1/campaigns/areas Create a new Area
CampaignsApi createExperienceArea POST /v1/campaigns/experience-areas Create a new ExperienceArea
CampaignsApi createFocusArea POST /v1/campaigns/focus-areas Create a new FocusArea
CampaignsApi createPoi POST /v1/campaigns/pois Create a new POI
CampaignsApi deleteArea DELETE /v1/campaigns/areas/{areaId} Delete an Area
CampaignsApi deleteExperienceArea DELETE /v1/campaigns/experience-areas/{experienceAreaId} Delete a ExperienceArea
CampaignsApi deleteFocusArea DELETE /v1/campaigns/focus-areas/{focusAreaId} Delete a FocusArea
CampaignsApi deletePoi DELETE /v1/campaigns/pois/{poiId} Delete a POI
CampaignsApi deletePoiPhoto DELETE /v1/campaigns/pois/{poiId}/photos/{photoId} Delete a POI Photo
CampaignsApi findAreas GET /v1/campaigns/areas Find Areas
CampaignsApi findExperienceAreas GET /v1/campaigns/experience-areas Find ExperienceAreas
CampaignsApi findFocusAreas GET /v1/campaigns/focus-areas Find FocusAreas
CampaignsApi findOwnAreas GET /v1/campaigns/areas/self Find own Areas
CampaignsApi findOwnPois GET /v1/campaigns/pois/self Find own POIs
CampaignsApi findPois GET /v1/campaigns/pois Find POIs
CampaignsApi getArea GET /v1/campaigns/areas/{areaId} Get an Area
CampaignsApi getExperienceArea GET /v1/campaigns/experience-areas/{experienceAreaId} Get a ExperienceArea
CampaignsApi getFocusArea GET /v1/campaigns/focus-areas/{focusAreaId} Get a FocusArea
CampaignsApi getPoi GET /v1/campaigns/pois/{poiId} Get a POI
CampaignsApi updateArea PUT /v1/campaigns/areas/{areaId} Update an Area
CampaignsApi updateExperienceArea PUT /v1/campaigns/experience-areas/{experienceAreaId} Update a ExperienceArea
CampaignsApi updateFocusArea PUT /v1/campaigns/focus-areas/{focusAreaId} Update a FocusArea
CampaignsApi updatePoi PUT /v1/campaigns/pois/{poiId} Update a POI
DefaultApi clientInfoControllerGetClientInfo GET /v1/client-info
DivisionsApi findDivisions GET /v1/divisions Find divisions
DivisionsApi getDivision GET /v1/divisions/{divisionId} Get division by id
GnetzApplicationsApi findGnetzApplications GET /v1/gnetz-applications Find GNetz Applications
HealthApi healthGet GET /health
NbApiApi findGroups GET /v1/party/groups Find all groups
NbApiApi findOrganizations GET /v1/party/organizations Find all organizations
NbApiApi findRegionalChapters GET /v1/party/regionalchapters Find all regional chapters
NbApiApi getRegionalChapter GET /v1/party/regionalchapters/{divisionKey} Get regional chapter by division key
NewsApi findNews GET /v1/news Find news
NewsApi getNews GET /v1/news/{newsId} Get a news post
OffboardingApi batchUpdateOffboardingServiceUsers POST /v1/offboarding/users/self/batch Batch update offboarding users for the authenticated service.
OffboardingApi findUsersToOffboard GET /v1/offboarding/users/self Find users to offboard for the service associated with the used credentials
ProfilesApi createProfile POST /v1/profiles Create user profile
ProfilesApi deleteProfile DELETE /v1/profiles/{profileId} Delete user profile
ProfilesApi deleteProfileImage DELETE /v1/profiles/{profileId}/image Delete user profile image
ProfilesApi findProfileTags GET /v1/profile-tags List profile tags
ProfilesApi findProfiles GET /v1/profiles Find user profiles
ProfilesApi getOwnProfile GET /v1/profiles/self Get the authenticated user's profile
ProfilesApi getProfile GET /v1/profiles/{profileId} Get a user profile
ProfilesApi updateProfile PUT /v1/profiles/{profileId} Update user profile
ProfilesApi updateProfileImage PUT /v1/profiles/{profileId}/image Update profile image
RolesApi findRoleCategories GET /v1/role-categories Find role categories
RolesApi findRoleTags GET /v1/role-tags Find role tags
RolesApi findRoles GET /v1/roles Find roles
RolesApi getRole GET /v1/roles/{roleId} Get role by id
UsersApi findUsers GET /v1/users Find users
UsersApi getSelf GET /v1/users/self Get the authenticated user
UsersApi getUser GET /v1/users/{userId} Get user by id
UsersApi getUserRbacStructure GET /v1/users/{userId}/rbac-structure Get user RBAC structure

Models

Authorization

basic

bearer

api_key

Tests

To run the tests, use:

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:


All versions of gruene-api-client with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package verdigado/gruene-api-client contains the following files

Loading the files please wait ....