Zum Hauptinhalt springen
Version: 1.0.0

Memida API

Introduction

The Memida API is built on HTTP. Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language.

To ensure you receive JSON data, please include the Accept: application/json header in your HTTP request.

Authentication

You can generate your API key under Settings, and delete API keys (as you may need to rotate your keys in the future). You authenticate to the Memida API by providing your secret key in the request header.

Memida offers one form of authentication: private key.

  • private key: authenticates by the HTTP header: Auth (read more on this below).

Never share your secret keys. Keep them guarded and secure. The client-side authentication scheme uses one HTTP header named Auth.

{
    Auth: 'live XXXXXXXXXXXXXXXXXXXXXXX'
}

API Error Responses

In our REST API, we follow standard HTTP status codes to indicate the result of each request. When an error occurs, the API will return a JSON object with a dynamic error message to help you diagnose and resolve the issue.

Dynamic Validator Response​

{
    error: {
        type: {
            is_type: 'type is not valid'
        }
    }
}

HTTP Dynamic Response​

{
    message: 'Not Found',
    url: '/api/v1/files/info/50ece4de-1468-4a07-83f1-f66d5c1d397e4',
    code: 404
}

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

Auth

Contact

Memida API Team: api@memida.de