MIO API

A collection of REST based APIs to programmatically interact with MIO platforms.

https://api.makeit-online.de

https://api.makeit-online.de/v0.9

Use the header fields for authentication to the API and submitting or receiving any content.

mio-auth-token

string required

The mio-auth-token is the session token obtained from authenticating to MIO API using your api key and is required on all calls after authentication.

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

The API methods allow access to MIO data.

Step 1: authentication of the accessing application
Step 2: Retrieve customer- / order-data assigned to your API key

Use the authentication services to log in to the MIO API with your application key, to validate your session token or to end your session.

Authenticate to MIO / Login

POST /service/authenticate

Validate MIO Authentication

GET /service/authenticate

Delete MIO session / Logout

DELETE /service/authenticate

POST /service/authenticate

Pass in your API key to the autenticate call to get back a mio-auth-key to use in all subsequent calls. NOTE: The mio-auth-key is not required on this call. This call requires the API key to be posted to the system to get back a mio-auth-key.

Request headers

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

Request body

Send the API-Key in the request body.

string

Example:

4H0F3V80-C2DB-4711-8093360D6899CB98

Responses

200 OK

Authentication success

Body

mio-auth-token

string

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

400 Bad Request

Request failed

401 Unauthorized

Authentication failed

Example Request

Example Response

POST request with API-Key in the request body

curl --data "4H0F3V80-C2DB-4711-8093360D6899CB98" \
     --header "Content-Type: application/json" \
     https://api.makeit-online.de/v0.9/service/authenticate/

Response with “mio-auth-token” in the body

"B0A61931-E90D-4E49-B60A-741D4F91C3CE"

GET /service/authenticate

Authentication

Auth Token

AuthUser

Use this call to validate if your MIO session token is still valid

Request headers

mio-auth-token

string required

The mio-auth-token is the session token obtained from authenticating to MIO API using your api key and is required on all calls after authentication.

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

Responses

200 OK

Valid Authentication

Body

string

Example:

Valid API Auth-Token

400 Bad Request

Request failed

401 Unauthorized

Authentication failed

Example Request

Example Response

GET request with “mio-auth-token” in header

curl --header "Content-Type: application/json" \
     --header "mio-auth-token: B0A61931-E90D-4E49-B60A-741D4F91C3CE" \
     https://api.makeit-online.de/v0.9/service/authenticate/

Response if “mio-auth-token” is a valid auth token

"Valid API Auth-Token"

DELETE /service/authenticate

Authentication

Auth Token

AuthUser

Remove this session key for usage.

Request headers

mio-auth-token

string required

The mio-auth-token is the session token obtained from authenticating to MIO API using your api key and is required on all calls after authentication.

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

Responses

200 OK

Logout success

Body

string

Example:

Authorization Deleted

400 Bad Request

Request failed

401 Unauthorized

Authentication failed

Example Request

Example Response

DELETE request with “mio-auth-token” in header

curl --header "Content-Type: application/json" \
     --header "mio-auth-token: B0A61931-E90D-4E49-B60A-741D4F91C3CE" \
     --request DELETE \
     https://api.makeit-online.de/v0.9/service/authenticate/

Authorization Deleted

Use the Order Services to retrieve all order data and manage the status of orders.

Get Open Orders

GET /service/order/list/open

Get Order

POST /service/order

Set Order Status

POST /service/setOrderStatus

GET /service/order/list/open

Authentication

Auth Token

AuthUser

Get an array of OrderIDs of open orders that are assigned to your API key / your user account. You need these OrderIDs to receive the complete order informations.

Request headers

mio-auth-token

string required

The mio-auth-token is the session token obtained from authenticating to MIO API using your api key and is required on all calls after authentication.

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

Responses

200 OK

Body

Object

OrderId

integer

Unique OrderId

Example:

14567

400 Bad Request

Request Failed

401 Unauthorized

Authentication Failed

Example Request

Example Response

curl --header "Content-Type: application/json" \
     --header "mio-auth-token: B0A61931-E90D-4E49-B60A-741D4F91C3CE" \
     https://api.makeit-online.de/v0.9/service/order/list/open/

[
    {"OrderId":1345},
    {"OrderId":1346},
    {"OrderId":1347}
]

POST /service/order

Authentication

Auth Token

AuthUser

Get the complete order information.

Request headers

mio-auth-token

string required

The mio-auth-token is the session token obtained from authenticating to MIO API using your api key and is required on all calls after authentication.

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

Request body

Object

OrderId

integer

OrderId of the order to retrieve all informations from.

Example:

14567

Responses

200 OK

Body

Object

Rechnungsanschrift

Object

Billing address

Firma

string nullable

Company

Max length: 50

Example:

Firma Verbraucher GmbH

Anrede

string nullable

Form of address

Max length: 10

Example:

Frau

Titel

string nullable

Title

Max length: 20

Example:

Prof. Dr.

Vorname

string required

First name

Max length: 50

Example:

Michael

Nachname

string required

Last name

Max length: 50

Example:

Musterperson

Strasse

string required

Street

Max length: 100

Example:

Musterstraße 4

Plz

string required

ZIP

Max length: 10

Example:

14471

Land

string required

Country

Max length: 50

Example:

Deutschland

CountryCode

string required

CountryCode (ISO 3166 ALPHA-2)

Max length: 2

Example:

Telefon

string required

Phone number

Max length: 30

Example:

+49 40 123 456 77

Mobil

string nullable

Mobile phone number

Max length: 30

Example:

+49 177 123 456 77

Fax

string nullable

Fax number

Max length: 30

Example:

+49 40 123 456 78

Ort

string required

City

Max length: 50

Example:

Musterstadt

Region

string nullable

Region / federal state

Max length: 30

Example:

Nordrhein-Westfalen

string required

E-Mail Address

Example:

m.musterperson@email-online.de

Valid

boolean required

MIO boolean flag for address validation

Example:

true

Lieferanschrift

Object

Delivery address

Name_1

string nullable

Address line 1

Max length: 100

Example:

Michael Musterperson

Name_2

string nullable

Address line 2

Max length: 100

Example:

3.Etage links

Strasse

string nullable

Street

Max length: 100

Example:

Musterstraße 4

Plz

string nullable

ZIP

Max length: 10

Example:

35647

Ort

string nullable

City

Max length: 50

Example:

Musterstadt

Land

string nullable

Country

Max length: 50

Example:

Deutschland

CountryCode

string nullable

CountryCode (ISO 3166 ALPHA-2)

Max length: 2

Example:

Warenkorb

Array

Cart

Object

PosText

string required

Item description

Max length: 500

Example:

Position / Produktbeschreibung

ArtikelNummer

string required

ItemID

Max length: 30

Example:

140

Menge

integer required

Order quantity

Example:

Preis

number required

Item price

Example:

7.8

PreisPos

number required

Total price position

Example:

22.92

Rabatt

integer

Discount position in percent

RabattFaehig

integer required

Discountable

Enumeration:

Yes

MwSt

integer

VAT

Enumeration:

No VAT

Low

High

OrderTimestamp

string date-time

Order DateTime Object

Example:

{ts '2019-07-20 22:14:16'}

SummePositionen

number

Example:

22.92

Fracht

number

Example:

5.5

SummeGesamt

number

Example:

28.42

Zahlungsart

integer

Payment method

Enumeration:

Invoice

Direct debit

Direct debit from known bank account

Bankverbindung

Object

BankDetails if Zahlungsart = 9

AccountHolder

string

Account Holder

Example:

Michael Musterperson

IBAN

string

International Bank Account Number

Example:

DE07123412341234123412

BIC

string

Bank Identifier Code

Example:

HARPDEHHYXX

GutscheinWert

number nullable

Voucher value

Example:

MwstValStruct

Object

Order VAT values

integer

No VAT

Example:

integer

Low in percent

Example:

integer

High in percent

Example:

SummeNetto

Object

Order net values

number nullable

Total net no VAT

Example:

12.77546876534

number nullable

Total net low VAT

Example:

27.066666666667

number nullable

Total net high VAT

Example:

45.765342789654

SummeBrutto

Object

Order gross values

number nullable

Total gross no VAT

Example:

25.76

number nullable

Total gross low VAT

Example:

28.42

number nullable

Total gross high VAT

Example:

127.45

SummeMwSt

Object

integer nullable

Total no VAT

number nullable

Total low VAT

Example:

1.353333333333

number nullable

Total high VAT

Example:

12.534787654231

Total

Object

Total Net/VAT

Netto

number required

Total net

Example:

27.066666666667

MwSt

number required

Total VAT

Example:

1.353333333333

SummeMengenrabatt

number nullable

Total quantity discount

Example:

12.33

SummeRabattProzent

number nullable

Total discount in €

Example:

0.48

RabattProzent

number nullable

Discount in percent

Example:

Charged

number nullable

Charged in €

Example:

13.77

Auftragsnummer

string

Auftragsnummer

Example:

710-4711

Camefrom

string

Internal flag / request origin

Enumeration:

Document

Origin: document values

Live

Origin: Live shop values

Example Request

Example Response

curl --data "8081" \
     --header "Content-Type: application/json" \
     --header "mio-auth-token: 234D9218-1459-4FEC-8E9A-BC9210931D0A" \
  http://api.makeit-online.de/v0.9/service/order/

{
    "Rechnungsanschrift":
    {
        "Firma":"",
        "Anrede":"",
        "Titel":"",
        "Vorname":"Michael",
        "Nachname":"Musterperson",
        "Strasse":"Musterstraße 4",
        "Plz":"87471",
        "Ort":"Musterstadt",
        "Region":"",
        "Land":"Deutschland",
        "CountryCode":"DE",
        "Telefon":"",
        "Mobil":"",
        "Fax":"",
        "Email":"m.musterperson@email-online.de"
        "Valid":true,
    },
    "Lieferanschrift":
    {
        "Name_1":"",
        "Name_2":"",
        "Strasse":"",
        "Plz":"",
        "Ort":"",
        "Land":""
        "CountryCode":"",
    },
    "Warenkorb":
    [
        {
            "PosText":"Positionstext / Produktbeschreibung",
            "ArtikelNummer":"140",
            "Menge":3
            "Preis":7.80,
            "PreisPos":22.92,
            "Rabatt":0,
            "RabattFaehig":1,
            "MwSt":1
        }
    ],
    "SummePositionen":22.92,
    "Fracht":5.50,
    "SummeGesamt":28.42,
    "GutscheinWert":0,
    "Zahlungsart":0,
    "MwstValStruct":
    {
        "0":0,
        "1":7,
        "2":19
    },
    "SummeMwSt":
    {
        "0":0,
        "1":1.353333333333,
        "2":0
    },
    "SummeNetto":
    {
        "0":0,
        "1":27.066666666667,
        "2":0
    },
    "SummeBrutto":
    {   "0":0,
        "1":28.42,
        "2":0
    },
    "Total":{
        "Netto":27.066666666667,
        "MwSt":1.353333333333}
    },
    "SummeMengenrabatt":0,
    "RabattProzent":2,
    "SummeRabattProzent":0.48,
    "Charged":0,
    "Camefrom":"Document",
}

POST /service/setOrderStatus

Authentication

Auth Token

AuthUser

Set the order status in the MIO order processing.

Request headers

mio-auth-token

string required

The mio-auth-token is the session token obtained from authenticating to MIO API using your api key and is required on all calls after authentication.

Example:

B0A61931-E90D-4E49-B60A-741D4F91C3CE

Content-Type

string required

All responses for the service come back as JSON. This header is required on all calls after authentication.

Default:

application/json

Request body

Object

OrderID

integer

OrderId of the order to change the order status.

Example:

14567

Status

integer

Order Status

Enumeration:

open

pending

cancellation

Responses

200 OK

Body

returns true if the order status has been changed

boolean

Example:

true

Example Request

Example Response

curl --data "{\"OrderId\": 8081, \"Status\": 1}"  \
     --header "Content-Type: application/json" \
     --header "mio-auth-token: 234D9218-1459-4FEC-8E9A-BC9210931D0A" \
  https://api.makeit-online.de/v0.9/service/setOrderStatus/

true