Download the PHP package mittwald/api-client without Composer

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

Example code of mittwald/api-client

Informations about the package api-client

mittwald API PHP client

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:

Usage

Import the client:

To create a client instance you can use one of the following factory methods for different types of authentication:

  1. MittwaldAPIClient::newUnauthenticated()
  2. MittwaldAPIClient::newWithToken(string $apiToken) (recommended)
  3. MittwaldAPIClient::newWithCredentials(string $email, string $password), does actually perform a login in the background; does not work when using 2FA.
  4. MittwaldAPIClient::newWithAccessTokenRetrievalKey(string $userId, string $key), authenticates an mStudio user using the access token retrieval key mechanism. Only useful if you're building an mStudio extension.
  5. MittwaldAPIClient::newWithExtensionSecret(string $extensionInstanceId, string $extensionSecret), authenticates an mStudio extension itself (without any user interaction). Only useful if you're building an mStudio extension.

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

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.

All versions of api-client with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
guzzlehttp/guzzle Version ^7.8
justinrainbow/json-schema Version ^5.2
caseyamcl/guzzle_retry_middleware Version ^2.9
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 mittwald/api-client contains the following files

Loading the files please wait ....