Download the PHP package optigov/optigov-api-php without Composer

On this page you can find all versions of the php package optigov/optigov-api-php. 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?

Example code of optigov/optigov-api-php

Informations about the package optigov-api-php

optigov-api-php

Für weitere Informationen, siehe optiGov-Dokumentation.

Installation

Schnellstart

Instanziierung

Ein optiGov-Client kann über die Client-Klasse intantiiert werden. Dabei werden die Urls des API-Endpunkts, des OAuth2.0-Auth-Endpunkts und des OAuth2.0-Token-Endpunkts benötigt.

Abfragen

Die Abfragen innerhalb der Bibliothek teilen sich in sogenannte Responsibilities auf. Diese enthalten verschiedene Verantwortlichekeiten - so ist z.B. die GlobalResponsibility für alle allgemeinen, von einer Verwaltung losgelösten Anfragen zuständig. Die VerwaltungResponsibility handelt alle Abfragen bzgl. aller Einträge einer Verwaltung ab - und die BuergerResponsibility übernimmt alle Funktionen, welche eine Bürgerauthorisierung benötigen.

Die GlobalResponsibility

Eine Dienstleistung, oder nur ihren Namen abfragen:

Eine Einrichtung, oder nur ihren Namen abfragen:

Einen Mitarbeiter, oder nur seinen / ihren Namen abfragen:

Um einen Bürger einzuloggen verwendet diese Bibliothek den von optiGov bereitgestellten OAuth2.0 Authorization-Flow mit PKCE. Dieser wird in zwei Schritten durchgeführt. Als Erstes wird eine URL zur Authorisierung für die Weiterleitung erzeugt:

Nachdem nun der Bürger eingeloggt ist und an die OPTIGOV_OAUTH_CLIEBNT_REDIRECT_URL der Authorization-Code gesendet wurde, kann darüber das Access- und Refresh-Token wie folgt abgefragt werden:

Die VerwaltungResponsibility

Alle Dienstleistungen abfragen:

Alle Themenfelder abfragen:

Alle Einrichtungen abfragen:

Alle Mitarbeiter abfragen:

Die BuergerResponsibility

Alle Anträge eines Bürgers abfragen:

Alle Termine eines Bürgers abfragen:

Alle Chats eines Bürgers abfragen:

Einen Chat eines Bürgers abfragen:

Alle Daten eines Bürgers abfragen:

Einen Antrag mit vorbefüllten Daten stellen:

Eine Datei hochladen:

Alle Daten eines Bürgers löschen:

Einen neuen Chat erstellen:

Eine neue Nachricht senden:

Tests und Beteiligung

Unit-Tests

Hinweis: Die Unit-Tests benötigen die Datei tests/bootstrap.php, welche notwenige (folgende) Konstanten definiert:

Ausführen aller Tests:

Beteiligung

Für Beteiligung an der Entwicklung der Bibliothek wenden Sie sich bitte an [email protected].

All versions of optigov-api-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
ext-curl Version *
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 optigov/optigov-api-php contains the following files

Loading the files please wait ....