BaaS API Documentation

API Endpoint
https://yourserver.tld/BaaS/index.php
API KEY =

This is the official documentation for communication with the BaaS Backend Server.

API Version: 1.0

 

Getting Started

All requests must be made with POST and can with a body which starts with JSON=

Base HTTP Codes

Responses 200 406 406 501 
OK.

/* This is a warning that the used API Key is INVALID */
{
    "Status":"Failed",
    "Warning":"You are using an invalid API key for this service.",
    "Details":"BaaS/VERSION, Connection: Close, IP-Address: YOUR_IP",
    "APIKey":"SENT_API_KEY_IF_ANY"
}

/* This is a warning that the used API Key is INVALID,
   And there are no retries left.
   The IP-Address is banned */
{
    "Status":"Failed",
    "Warning":"You are blocked from using this service.",
    "Details":"BaaS/VERSION, Connection: Close, IP-Address: YOUR_IP",
    "APIKey":"SENT_API_KEY_IF_ANY"
}

/* Invalid request, Method does not exists. */
{
    "Status":"Failed",
    "Error":"Method not implented.",
    "Method":"HTTP_METHOD",
    "Data":"REQUESTED DATA",
    "ReqURI":"REQUESTED_URI"
}

Base HTTP Codes
POST/

You can always get one of this HTTP Status codes back.
Carefully read them.


Post data 

N/A

Invalidate all sessions

Responses Ok Failed 
{
    "Status":"Success",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Sessions invalidated"
}

{
    "Status":"Failed",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Sessions continued"
}

Invalidate all sessions
POST/session.admin.invalidateAll

Invalidate all sessions.


Post data 

{
    "APIKey":"YOUR_API_KEY",
    "SessionID":"YOUR_SESSION_TOKEN"
}

Continue a session

Responses Ok Failed 
{
    "Status":"Success",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Session continued"
}

{
    "Status":"Failed",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Session invalidated"
}

Continue a session
POST/session.continue

Continue a running session (if the session is not timedout/expired)
Note: Always save the new SessionID this could change due to protection.


Post data 

{
    "APIKey":"YOUR_API_KEY",
    "SessionID":"YOUR_SESSION_TOKEN"
}

Create a session

Responses Ok Failed 
{
    "Status":"Success",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Session created"
}

{
    "Status":"Failed",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Session invalidated"
}

Create a session
POST/session.create

Create a new session id.


Post data 

{
    "APIKey":"YOUR_API_KEY",
    "SessionID":"YOUR_SESSION_TOKEN"
}

Invalidate a session

Responses Ok Failed 
{
    "Status":"Success",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Session invalidated"
}

{
    "Status":"Failed",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Session continued"
}

Invalidate a session
POST/session.invalidate

Invalidate a session.


Post data 

{
    "APIKey":"YOUR_API_KEY",
    "SessionID":"YOUR_SESSION_TOKEN"
}

Activate user

Responses Ok Failed 
(HTML Website)

(HTML Website)

Activate user
GET/user.activate/ActivationToken

Activate user (WEB-Call), Only if user activation is required.


Post data 

N/A

Create a user

Responses User Created Password Mismatch Email already in use Registration disabled Other error 
{
    "Status":"Success",
    "Details":"User account created"
}

{
    "Status":"Failed",
    "Details":"Password mismatch"
}

{
    "Status":"Failed",
    "Details":"Email in use"
}

{
    "Status":"Failed",
    "Details":"Registration disabled"
}

{
    "Status":"Failed",
    "Details":"The error about what went wrong"
}

Create a user
POST/user.create

With this call you can create a user.


Post data 

{
    "APIKey":"YOUR_API_KEY",
    "username":"THE_USERNAME",
    "password":"THE_PASSWORD",
    "email":"THE_EMAIL"
}

Login a user

Responses Logged In Login Failed Login Disabled 
{
    "Status":"Success",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"User logged in"
}

{
    "Status":"Failed",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Username/Password incorrect"
}

{
    "Status":"Failed",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"Login disabled"
}

Login a user
POST/user.login

With this call you can login a user.


Post data 

{
    "APIKey":"YOUR_API_KEY",
    "password":""
}

Logout a user

Responses Logged In 
{
    "Status":"Success",
    "SessionID":"YOUR_SESSION_TOKEN",
    "Details":"User logged out"
}

Logout a user
POST/user.logout

With this call you can logout a user.


Post data 

{
    "APIKey":"YOUR_API_KEY"
}

Last update Fri 09 Aug 2019