Note:
This section is no longer updated, please click here for updated documentation.
Explore Platform Chat API's as Application Admin or as Application User.
These APIs allow to directly connect to the Applozic Cloud Messaging Backend Server.
HEADERS
Application Admin
Application admin is the user who has done signup in Applozic dashboard .
Apz-AppId
Application key got in Applozic dashboard for which admin want to call API.
Apz-Token
Apz-Token is used for authentication purpose. Authentication is done using Basic Authentication. It is a combination of the base64 value of email & password.
Basic Base64Encode of email:password
Example: Basic amFja0BnbWFpbC5jb206MTIzNDU2
Content-Type
application/json
Of-User-Id
On behalf of which Application Admin want to call the API
For Application Admin sends following authentication headers with each API call to explore platform API's. A request should contain these headers:
Note: Pass Of-User-Id header only where it is required, it is specified in the API details.
Example- If the email of the admin(Logged in Applozic Dashboard) is jack@gmail.com and password is 123456 then the header will be:
Apz-AppId
21040368s3869d9b2b7b2f953ae28cf
Apz-Token
Basic amFja0BnbWFpbC5jb206MTIzNDU2
Content-Type
application/json
Application User
All request from Device must contain following headers:
Application-Key
Your Application Key
Authorization
Authentication is done using Basic Authentication. It is a combination of the base64 value of userId & deviceKey.
Basic Base64Encode of userId:deviceKey
Example: Basic cm9iZXJ0OjA5YzVkODY5LTZkMzgtNGQ2Yi05ZWJmLTlkZTE2Y2RhYjE3Ng==
Device-Key
Device key is received when application user does registration using register/client API. Use Device-Key to create Authorization Code and send Device-Key also in the request header.
Example- If the userId is robert and deviceKey is 09c5d869-6d38-4d6b-9ebf-9de16cdab176, then the authorization code will be:
Application-Key
TestApp
Authorization
Basic cm9iZXJ0OjA5YzVkODY5LTZkMzgtNGQ2Yi05ZWJmLTlkZTE2Y2RhYjE3Ng==
Device-Key
09c5d869-6d38-4d6b-9ebf-9de16cdab176
UserId-Enabled
true
Note: Additional header Access-Token is also required if the user password is set in Applozic.
Access-Token
user password
Note: Headers are required in each API call except user registration .ie register/client API.
What's Next
| Register User |