User Management | REST (JSON) API DOCUMENTATION


Menu :




Separator


API Overview

User management :



Create :

GET http://eenox.net/api/create/user/[lang]/[username]/[email]/[password]/[apikey]

Modify :

 GET http://eenox.net/api/modify/user/[lang]/[username]/[email]/[password]/[token]

Delete :

 GET http://eenox.net/api/delete/user/[token]




Separator




Create Eenox user : GET http://eenox.net/api/create/user/[lang]/[username]/[email]/[password]/[apikey]




HTTP REQUEST : Method GET
HTTP RESPONSE : Content-type application/json


Contact us to get your (company's) private API Key.

Ex :
http://eenox.net/api/create/user/en/johndoe/john.doe@mail.com/johnpassword/82RT7F

You will get a unique AUTH TOKEN, (like the one from the JSON object below) for each user. STORE EACH AUTH TOKEN SAFELY to authenticate your users and call REST actions anytime from your web server (STATELESS WAY).


For each request, either you will get successful JSON object response :


Ex :
{
'STATUS' : 'SUCCESS',
'LABEL' : 'Created successfully',
'TOKEN' : '2cd0f5dae55e15d1d83797c03397222344561f64'
}

Or unsuccessful JSON object without TOKEN but with an explicit human readable label explaining why creation failed :


Ex :

{
'STATUS' : 'ERROR',
'LABEL' : 'Missing REST parameters'
}


{
'STATUS' : 'ERROR',
'LABEL' : 'Username too long > 40'
}

Separator




Modify Eenox user : GET http://eenox.net/api/modify/user/[lang]/[username]/[email]/[password]/[token]




HTTP REQUEST : Method GET
HTTP RESPONSE : Content-type application/json


Ex :
http://eenox.net/api/modify/user/fr/john/another@email.com/anotherpwd/2cd0f5dae55e15d1d83797c03397222344561f64


Either you will get successful JSON object response :


Ex :
{
'STATUS' : 'SUCCESS',
'LABEL' : 'Modified successfully'
}

Or unsuccessful JSON object with an explicit human readable label explaining why request failed :


Ex :

{
'STATUS' : 'ERROR',
'LABEL' : 'Username invalid characters'
}


{
'STATUS' : 'ERROR',
'LABEL' : 'Email already exists'
}


Separator




Delete Eenox user : GET http://eenox.net/api/delete/user/[token]




HTTP REQUEST : Method GET
HTTP RESPONSE : Content-type application/json


Ex :
http://eenox.net/api/delete/user/2cd0f5dae55e15d1d83797c03397222344561f64


Either you will get successful JSON object response :


Ex :
{
'STATUS' : 'SUCCESS',
'LABEL' : 'Deleted successfully'
}

Or unsuccessful JSON object with an explicit human readable label explaining why request failed :


Ex :

{
'STATUS' : 'ERROR',
'LABEL' : 'User not found'
}


{
'STATUS' : 'ERROR',
'LABEL' : 'Missing REST parameters'
}



Separator