mittwald / api-client
Client library for the mittwald mStudio v2 API
Installs: 2 593
Dependents: 3
Suggesters: 0
Security: 0
Stars: 2
Watchers: 4
Forks: 0
Open Issues: 1
Requires
- php: ^8.2
- caseyamcl/guzzle_retry_middleware: ^2.9
- guzzlehttp/guzzle: ^7.8
- justinrainbow/json-schema: ^5.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.25
- phpunit/phpunit: ^10.5
- rector/rector: ^0.19.8
- vimeo/psalm: ^5.15
- dev-master
- v2.1.79
- v2.1.78
- v2.1.77
- v2.1.76
- v2.1.75
- v2.1.74
- v2.1.73
- v2.1.72
- v2.1.71
- v2.1.70
- v2.1.69
- v2.1.68
- v2.1.67
- v2.1.66
- v2.1.65
- v2.1.64
- v2.1.63
- v2.1.62
- v2.1.61
- v2.1.60
- v2.1.59
- v2.1.58
- v2.1.57
- v2.1.56
- v2.1.55
- v2.1.54
- v2.1.53
- v2.1.52
- v2.1.51
- v2.1.50
- v2.1.49
- v2.1.48
- v2.1.47
- v2.1.46
- v2.1.45
- v2.1.44
- v2.1.43
- v2.1.42
- v2.1.41
- v2.1.40
- v2.1.39
- v2.1.38
- v2.1.37
- v2.1.36
- v2.1.35
- v2.1.34
- v2.1.33
- v2.1.32
- v2.1.31
- v2.1.30
- v2.1.29
- v2.1.28
- v2.1.27
- v2.1.26
- v2.1.25
- v2.1.24
- v2.1.23
- v2.1.22
- v2.1.21
- v2.1.20
- v2.1.19
- v2.1.18
- v2.1.17
- v2.1.16
- v2.1.15
- v2.1.14
- v2.1.13
- v2.1.12
- v2.1.11
- v2.1.10
- v2.1.9
- v2.1.8
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.39
- v2.0.38
- v2.0.37
- v2.0.36
- v2.0.35
- v2.0.34
- v2.0.33
- v2.0.32
- v2.0.31
- v2.0.30
- v2.0.29
- v2.0.28
- v2.0.27
- v2.0.26
- v2.0.25
- v2.0.24
- v2.0.23
- v2.0.22
- v2.0.21
- v2.0.20
- v2.0.19
- v2.0.18
- v2.0.17
- v2.0.16
- v2.0.15
- v2.0.14
- v2.0.13
- v2.0.12
- v2.0.11
- v2.0.10
- v2.0.9
- v2.0.8
- v2.0.7
- v2.0.6
- v2.0.5
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v1.0.42
- v1.0.41
- v1.0.40
- v1.0.39
- v1.0.38
- v1.0.37
- v1.0.36
- v1.0.35
- v1.0.34
- v1.0.33
- v1.0.32
- v1.0.31
- v1.0.30
- v1.0.29
- v1.0.28
- v1.0.27
- v1.0.26
- v1.0.25
- v1.0.24
- v1.0.23
- v1.0.22
- v1.0.21
- v1.0.20
- v1.0.19
- v1.0.18
- v1.0.17
- v1.0.16
- v1.0.15
- v1.0.14
- v1.0.13
- v1.0.12
- v1.0.11
- v1.0.10
- v1.0.9
- v1.0.8
- v1.0.7
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- dev-next
- dev-feature/base-url-configurable
- dev-bugfix/schema-validation
- dev-chore/more-rector-rules
- dev-chore/custom-validator
- dev-chore/composer-php
- dev-feature/retry-requests
This package is auto-updated.
Last update: 2024-11-05 19:10:54 UTC
README
This package contains a (mostly auto-generated) PHP client for the mittwald mStudio v2 API.
License
Copyright (c) 2023 Mittwald CM Service GmbH & Co. KG and contributors
This project is licensed under the MIT License; see the LICENSE file for details.
Installation
You can install this package using composer:
$ composer require mittwald/api-client
Usage
Import the client:
use Mittwald\ApiClient\MittwaldAPIV2Client;
To create a client instance you can use one of the following factory methods for different types of authentication:
MittwaldAPIClient::newUnauthenticated()
MittwaldAPIClient::newWithToken(string $apiToken)
(recommended)MittwaldAPIClient::newWithCredentials(string $email, string $password)
(does actually perform a login in the background; does not work when using 2FA)
Have a look at our API introduction for more information on how to obtain an API token and how to get started with the API.
Example
use \Mittwald\ApiClient\Generated\V2\Clients\Project\ListProjects\ListProjectsRequest; $listProjectRequest = new ListProjectsRequest(); $listProjectResponse = $client->project()->listProjects($listProjectRequest); foreach ($listProjectResponse->getBody() as $project) { echo $project->getShortId() . PHP_EOL; }
API documentation
The API documentation can be found in our Developer Portal. You can find the operation ID on the right side of each operation.