rusttwald

Inofficial Rust API client for the mittwald. API.

Introduction

This OpenAPI spec documents the mittwald API. It follows the OpenAPI 3.0.0 specification.

Authentication

You will need an API token to access the API. You can obtain one by logging into the mStudio and navigating to the "API Tokens" section in the user menu.

When making requests to the API, you can authenticate by passing your API token in the X-Access-Token header or as a bearer token.

Rate Limiting

Please note that usage of the API is rate-limited to prevent abuse. You can inspect the rate limiting for your current user by observing the X-Ratelimit-* headers included in each response.

mStudio

A main consumer of the mittwald API is the management interface for our customers, the mStudio.

Contact and support

For support, please use the mStudio support area or drop us an email at support@mittwald.de.

For security issues, please report to security@mittwald.de.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 2.0
• Package version: 2.0
• Generator version: 7.7.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

Official Documentation

Generated Documentation

To get access to the crate's generated documentation, use:

cargo doc --open