Codelayer API Documentation

Note: This is alias of system/auth

Authenticates a user to the API using user name and password. On successful authentication a key is provided. For any further communication to the API the provided key must be used. This key expire/timeout. On such situations the application has to get another key by re-authentication to the API.

estate/auth

POST

application/json

application/json

Parameter	Data Type	Min	Max	M/O	Sample Value	Comments
key	String	32	32	M	RRvvOXImkSAqu0Iwbg7hY66AmBAyjwgH	Key obtained from authentiaction.
username	String	1	64	M	giri	This is the username provided to login to the API
password	String	1	64	M	reseT123	This is the password provided to login to the API.
imei	String	14	16	M	356905070867478	IMEI Of the accessing device
ver	String	7	16	M	1.0.0.0	Application version of the client. Current supported version is 1.0.0.1

 

Name	Data Type	Min Length	Max Length	M/O	Sample Value	Comments
key	String	32	32	M	QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq	This key to be used for all API calls (256 bit)

 

{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "username": "giri",
    "password": "reseT123",
    "imei": "356905070867478",
    "ver": "1.0.0.0"
}

{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "e": 200,
    "msg": "Success"
}

{
    "e": 401,
    "msg": "Invalid authentication credentials."
}