datana-gmbh / formulario-api
API for Formulario
Installs: 18 229
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 1
Requires
- php: >=8.2
- datana-gmbh/mandantencockpit-contracts: ^1.1
- fakerphp/faker: ^1.23
- oskarstark/trimmed-non-empty-string: ^1.0
- psr/log: ^1.1 || ^2.0 || ^3.0
- symfony/http-client: ^4.4 || ^5.1 || ^6.0
- thecodingmachine/safe: ^1.0 || ^2.0
- webmozart/assert: ^1.7
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-03 10:20:01 UTC
README
Usage
Installation
composer require datana-gmbh/formulario-api
Setup
use Datana\Formulario\Api\FormularioClient; $baseUri = 'https://api.formulario...'; $token = '...'; $timeout = 10; // optional $client = new FormularioClient($baseUri, $token, $timeout); // you can now request any endpoint which needs authentication $client->request('GET', '/api/something', $options);
Dateneingaben
In your code you should type-hint to Datana\Formulario\Api\DateneingabenApiInterface
Get by Aktenzeichen (string
)
use Datana\Formulario\Api\DateneingabenApi; use Datana\Formulario\Api\FormularioClient; use Datana\Formulario\Api\Domain\Value\DateneingabenId; $client = new FormularioClient(/* ... */); $api = new DateneingabenApi($client); $response = $api->byAktenzeichen('1abcde-1234-5678-Mustermann'); /* * to get the DateneingabenId transform the response to array * and use the 'id' key. */ $akten = $response->toArray(); $dateneingabenId = DateneingabenId::fromInt($akte['id']);
Get by ID (Datana\Formulario\Api\Domain\Value\DateneingabenId
)
use Datana\Formulario\Api\DateneingabenApi; use Datana\Formulario\Api\FormularioClient; use Datana\Formulario\Api\Domain\Value\DateneingabenId; $client = new FormularioClient(/* ... */); $api = new DateneingabenApi($client); $id = DateneingabenId::fromInt(123); $api->getById($id);
Statistics
In your code you should type-hint to Datana\Formulario\Api\StatisticsApiInterface
Get number of invitation mails sent for Mandantencockpit
use Datana\Formulario\Api\StatisticsApi; use Datana\Formulario\Api\FormularioClient; $client = new FormularioClient(/* ... */); $api = new StatisticsApi($client); $api->numberOfCockpitInvitationMailsSent(); // 42