Login to an Agent
You can login to any agent for an account.
accessing the account directly from this API endpoint is mostly meant for your end user client to do. he can login with the credentials you created for him bypassing the username/password and 2FA of accessing the online account directly. this is SSO login.
Moreover, you can build this solution over iFrame inside your own platform to allow accessing the system directly from your app.
Important Remarks
After creating login link, you must access it within 5 minutes and you can only access it once. if you need to access the same URL again, you must create a new link.
The URL you will get can be opened directly from your browser or from iFrame solution or implement it into your own application.
Settings:
URL | |
Method | JSON via POST |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example |
|---|---|
accountID | The account ID you wish to login to |
agentID | The agent ID you wish to login to |
server | The server subdomain hosting the account |
Response:
{
"status": "OK",
"accountID": 4142,
"agentID": 3142,
"server": "online",
"login": "https://online..."
}
Response-Explain:
Parameter | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request was successful. "Fail" means error. | ||||||||||||||||
accountID | The account ID you login to | ||||||||||||||||
agentID | The agent ID you login to | ||||||||||||||||
server | The server subdomain you login to | ||||||||||||||||
login | The login URL for that account | ||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|