Description
Authenticates the Sub-Reseller and returns the Reseller ID, if authenticated.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
username | String | Required | Username of the Sub-Reseller |
passwd | String | Required | Password of the Sub-Reseller |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/resellers/v2/authenticate.json?auth-userid=0&api-key=key&username=username@subreseller.com&passwd=subresellerpassword
Response
-
Returns a hash map containing the below details, if the Sub-Reseller is authenticated successfully:
-
Reseller Id (resellerid)
-
2-Step Verification status (twofactorauth_enabled)
-
-
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
-
In case of a failed login attempt, a status key with value as ERROR alongwith the following details will be returned.
-
Maximum number times login can be attempted (maxAttempts)
-
Login failure message (message)
-
Remaining number of login attempts (remainingLoginAttempts)
NoteThe account will be temporarily locked out for 30 minutes if remainingLoginAttempts is 0.
-