Documentation
Sso (v1)
Auth
POST /sso/auth
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| telephone | String | users telephone number |
YES |
| code | String | auth code from sms |
YES |
| agb | boolean | users agb confirmation |
NO |
| dataprotection | boolean | users data protection confirmation |
NO |
| pushToken | String | push token for sending push notifications |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Code
POST /sso/code
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| telephone | String | users telephone number |
YES |
| code | String | auth code |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
EmailOptin
PATCH /sso/email-optin
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| c | String | users code |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
EmailStatus
PATCH /sso/email-status
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| String | users email |
YES | |
| telephone | String | users telephone number |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Add users email address to profiles data
PATCH /sso/email
updates users email address and send opt in mail for submitting the change
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| String | users email address |
YES | |
| telephone | String | users telephone number |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"email": "users email address",
"telephone": "users telephone number"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Sms
POST /sso/sms
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
UserStatus
This service checks wether a user is registered or not.
POST /sso/user/status
post an array "user" with telephone numbers as elements to check if the users are registered. Keep in mind that the max amount of elements you can post is 100
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| user | array | users telephone number to check wether the user is still registered or not |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"user": "users telephone number to check wether the user is still registered or not"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"user": "users telephone number to check wether the user is still registered or not",
"isRegistered": "1 for yes and 0 for not registered"
}
User
User Information
POST /sso/user
match users login data with generated auth token
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| username | string | users telephone number |
YES |
| authCode | String | through login process generated auth code |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.sso.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"username": "users telephone number",
"authCode": "through login process generated auth code"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
'user': {
'id: int - USER-ID
'email' => String - USER EMAIL
'nickname': String - USER NICKNAME
'firstname': String - USER FIRSTNAME
'imageUrl': String - URL TO USERS PROFILE PICTURE
'verified': bool - THE USERS VERIFICATION STATUS
}
}
GET /sso/user
returns an user object with minimal user info
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| username | string | users telephone number |
YES |
| authCode | String | through login process generated auth code |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.sso.v1+json
application/json
application/*+json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.sso.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
'user': {
'id: int - USER-ID
'email' => String - USER EMAIL
'nickname': String - USER NICKNAME
'firstname': String - USER FIRSTNAME
'imageUrl': String - URL TO USERS PROFILE PICTURE
'verified': bool - THE USERS VERIFICATION STATUS
}
}