API-Documentation - Clients

Clients

This module delivers all client information.

Function overview

activate Check if client with given mail already exists.
activate Activate client by client.
checkLogin Check client login.
edit Edit personal client data, client login required.
get get personal client data, client login required.
getPasswordHash fetch password hash.
login Do client login.
orders/get Get single order for current client.
orders/getAll Get all orders of current client.
register Register client from outside.
resetPassword reset password.
validatePasswordHash validate password hash.
activate - Check if client with given mail already exists.post

Check if client with given mail already exists.

Url

/service/clients/exists

Parameter

Field Type Description
mail String

The client email to check for existance.

activate - Activate client by client.post

Activate client by client.

Url

/service/clients/activate

Parameter

Field Type Description
data Object

Client data.

checkLogin - Check client login.post

Check client login.

Url

/service/clients/checkLogin

Parameter

No parameter available for this function

edit - Edit personal client data, client login required.post

Edit personal client data, client login required.

Url

/service/clients/edit

Parameter

Field Type Description
data Object

Client data.

get - get personal client data, client login required.post

get personal client data, client login required.

Url

/service/clients/get

Parameter

No parameter available for this function

getPasswordHash - fetch password hash.post

fetch password hash.

Url

/service/clients/getPasswordHash

Parameter

Field Type Description
username String

Unique client username.

mail String

Unique client mail address.

number String

Unique client number.

login - Do client login.post

Do client login.

Url

/service/clients/login

Parameter

Field Type Description
mail String

Unique client mail address.

password String

Passhrase.

orders/get - Get single order for current client.post

Get single order for current client by id or uuid.

Url

/service/clients/orders/get

Parameter

Field Type Description
[id] Integer

Unique order ID.

( Optional. )

[uuid] String

Order UUID.

( Optional. )

orders/getAll - Get all orders of current client.post

Get all orders of current client

Url

/service/clients/orders/getAll

Parameter

No parameter available for this function

register - Register client from outside.post

Register client from outside.

Url

/service/clients/register

Parameter

Field Type Description
data Object

Client data.

resetPassword - reset password.post

reset password.

Url

/service/clients/resetPassword

Parameter

Field Type Description
mail String

Unique client mail address.

password String

new password phrase.

lostpassword_hash String

current password reset hash from /service/clients/getPasswordHash.

validatePasswordHash - validate password hash.post

validate password hash.

Url

/service/clients/validatePasswordHash

Parameter

Field Type Description
mail String

Unique client mail address.

lostpassword_hash String

current password reset hash from /service/clients/getPasswordHash.

© 2021 Vinou GmbH, Mombacher Straße 68, 55122 Mainz, Germany