TIFYDocumentation
The TIFYAPI is based in GraphQl to return JSON-encoded data. Using standard HTTP response code, authentication and object-oriented the TIFYAPI can be tailored to meet your functionality needs.
USE CASES
AUTHENTICATION
The TIFYAPI uses API keys or HTTP Basic Authentication to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API can be performed via HTTP post to the endpoint “\api\login”. Provide your password and username value as a JSON , you will get a key that can be used in any further request.
QUERY STYLES
All requests should go to the same endpoint which is “/api/?token=[your key] “ but what you need as a response could be customized in the body of the request for example if you would like to get a response for your own search include many different sources like sentiments and emotions you can add them in the include array like following : include[“sentiments”,”emotions”]]
Notice all the request that is going to be mentioned later is in a json format
TIFYScore
Examine how people are feeling, including the polarity of sentiment and the emotions conveyed within the posts about you.
Polarity
Returns a value from range; Overwhelmingly Negative, Negative, Slightly Negative, Neutral, Slightly Positive, Positive, Overwhelmingly Positive
REQUEST
{“search_value”:[your search],
“include”:[“sentiments”]}
RESPONSE
{"Sentiment" : "Overwhelmingly Positive"}
Emotions
Returns top 5 emotions
REQUEST
{“search_value”:[your search],
“include”:[“emotions”]}
RESPONSE
{"emotions": [{"emotion": "negative,"}, {
"emotion": "surprise"}, {
"emotion": "Positive"}]}
Prediction
Return value from range; Increasingly Positive, Steady Sentiment and Increasingly Negative.
REQUEST
{“search_value”:[your search],
“include”:[“prediction”]}
RESPONSE
{"Prediction" : "Increasingly Positive"}