Sign In API
Assuming your domain URL is analytics.finepick.com.
URL FORMAT
form method="POST" action="https://analytics.finepick.com/sso" target="_self"
input type= "hidden" name ="apikey" value="[your apikey]"
input type ="hidden" name ="operation" value ="signin"
input type ="hidden" name ="email" value ="[email id of the user to signin]"
input type ="submit" name ="Sign In" value ="submit"
/form
Important: You need to send an HTTPS POST to Zoho Analytics for user Sign In API.
INPUT PARAMETER FOR SIGN IN API
Description | |
---|---|
operation | Value is “signin” |
apikey | Your API key |
Email address of the user to sign in | |
STATE (optional) | Landing URL of specific workspace/view for redirection once the sign-in process is completed. Default value: https://[your domain]/ZDBHome.cc |
RESPONSE FOR SIGN IN API
Both success & failure responses are present in JSON format.
Return Value | Description |
---|---|
result | success/failure If the API call is successful, then success value is present in the result attribute; else failure value. |
zuid | ID generated by the Zoho system. Unique per user email address. This needs to be stored against the user for whom sign in API is being called. This will be useful for any communication / trouble shooting at a later stage. |
ticket | This is used by the user to access the reports present in the Zoho Analytics. This needs to be passed to Zoho as part of the URL. |
redirect_url | This is used by the user to complete the signin process. |
cause | This attribute present in the response, only in case of failure |
Sample Request:
Copiedcurl -d "apikey=apikey&operation=signin&email=[email id of the user to signin]"
https://[your domain]/sso
Sample Success Response:
Copied{ "ticket":"666b88566441b69d1a137db824314b6a9be8959a75b1a1be8b951c6e18f352bb
2e068f7f697fa4879e365e19967a5b537a08c8e85058625130e54e8467d85259",
"result":"success",
"redirect_url":"https://analytics.finepick.com/oauthorize?state=https%3A%2F%2Fanalytics.finepick.com%2FZDBHome.cc&zacode=1001872501-19e446dc-2398a43e6108e59a0458d550f0714628&portal=1000756871",
"zuid":5471
}
Sample Failure Response:
Copied{
"result":"failure",
"cause":"Invalid APIKey"
}