Sign Up 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 ="signup"

input type ="hidden" name ="email" value ="[email id of the user to signup]"

input type ="hidden" name ="full_name" value ="[Full Name of the user]"

input type ="submit" name ="Sign Up" value ="submit"

/form

Important: You need to send an HTTPS POST request to Zoho Analytics for user Sign Up API.

INPUT PARAMETERS FOR SIGN UP API

Parameter NameDescription
operationValue is “signup”
emailEmail Id of the user to sign up
full_name (optional)Full Name of the user
apikeyYour API key

RESPONSE FOR SIGN UP API:

Both Success & Failure responses are present in JSON format.

Return ValueDescription
resultsuccess/failure
If API call is success, then success value is present in the result attribute; else failure value.
zuidID generated by the Zoho system. Unique per user email address.
This needs to be stored against the user for whom sign up API is called.
This will be useful for any communication / trouble shooting at a later stage.
ticketThis 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.
causeThis attribute is present in the response, only in case of failure.

 

Sample Request:

Copiedcurl -d "apikey=apikey&operation=signup&email=[email id of the user to signup] 
         &full_name=[Full Name of the user]"
         https://[your domain]/sso

Sample Success Response

Copied{
"ticket":"666b88566441b69d1a137db824314b6a9be8959a75b1a1be8b951c6e18f352
              bb2e068f7f697fa4879e365e19967a5b537a08c8e85058625130e54e8467d
              85259",
    "result":"success",
    "zuid":5471
}

Sample Failure Response

Copied{
    "result":"failure",
    "cause":"Invalid APIKey"
}