Lyska Cloud API (dev)

Download OpenAPI specification:Download

This is an awesome API!

Authentication

apiKey

Security Scheme Type API Key
Header parameter name: X-API-KEY

jwt

Value: Bearer [token]

Security Scheme Type API Key
Header parameter name: Authorization

Customer

Creates new JWT Token for the selected Channel.

Authorizations:
path Parameters
channelId
required
string

Uuid of the channel which should be used.

Responses

Registers a new Customer.

Authorizations:
Request Body schema: application/json
clientFields
object (RegisterClientFieldCollection)
type
required
string
Enum: "personal" "company"
company
required
string Nullable

Field will be required when type=company.

email
string
password
string
number
required
string Nullable

Number will be generated if not provided

channel
string
firstName
required
string
lastName
required
string
gender
required
string
object (ExtendedRegistrationInformation)

Responses

Request samples

Content type
application/json
{
  • "clientFields": { },
  • "type": "personal",
  • "company": "Lyska",
  • "email": "erika.musterfrau@lyska.io",
  • "password": "p4$$w0rd",
  • "number": "xyz-1000",
  • "channel": "cfb89b73-670e-46de-acee-77d31cc5e6ea",
  • "firstName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "extendedInformation": {
    }
}

Updates a Customer.

Authorizations:
Request Body schema: application/json
clientFields
object (CustomerClientFieldCollection)
companyName
string

Mandatory (not blank) if customerType is set to company.

type
required
string
Enum: "personal" "company"
channel
string

Responses

Request samples

Content type
application/json
{
  • "clientFields": { },
  • "companyName": "Lyska",
  • "type": "personal",
  • "channel": "string"
}

Completes registration and activates new User.

Authorizations:
Request Body schema: application/json
secret
required
string

Responses

Request samples

Content type
application/json
{
  • "secret": "string"
}

Refreshes secret and sends new email.

Authorizations: