Skip to content

API_1_LOGIN_APP

pvicente edited this page Nov 7, 2013 · 22 revisions

API ▸ Login API 1 ###POST /1/google/:appid

Login of appid in KatooServer

###Resource URL https://katooserver.herokuapp.com/1/google/:appid

Parameters  
appid required String: Application ID
jid required String: XMPP JID
token required String: OAUTH2 token to login with Google XMPP service
refreshtoken required String: OAUTH2 refresh token to generate new tokens
resource required String: xmpp resource of app
pushtoken optional String: Push Notification Token. Client identifier to be used with the APNS to send notifications. Empty String if client doesn't have enabled push notifications
badgenumber optional Integer: Badge number of app
pushsound optional String: Push Notification Sound. Sound name (including extension) configured by the user for notifications
favoritesound optional String: Push Notification Favorite Sound. Sound name (including extension) configured to favorite user notifications
lang optional String: User language for custom push notification Default: en-US

State Machine

|appid|Status Connected|Actions| |:-------------|:--|:--|:--|:--|:--| | Found | T | Client connected response. None action (If you need to update any data perform a PUT action over REST/API))| | Found | F | OK Response. Remove current user and relogin | | Not Found | - | OK Response. Login user |

###OK Response

JSON

{
 "success": True, 
 "reason": "ok",
 "background_time": 180,
 "resource_prefix": "katooserver",
 "gtalk_priority": 24,
 "ads_gift": False
}

###Client connected response JSON

{
  "success": False, 
  "reason": "Already logged",
  "background_time": 180,
  "resource_prefix": "katooserver",
  "gtalk_priority": 24,
  "ads_gift": False
}

###success True or False

###reason ok when success == True or string message when success == False

###background_time Client app background time in seconds

###resource_prefix XMPP resource prefix sent to server for each XMPP connection. (Useful to detect katoo resources in XMPP)

###gtalk_priority Priority of Gtalk protocol to configure client priority states

###ads_gift True or False if we are giving ads for free

Clone this wiki locally