Documentation
WEBACCOUNT
usage
<WEBACCOUNT ID="number">
<INFO>
<ID>number</ID>
<ACTIVITY>1</ACTIVITY>
<ISLOCKED>0</ISLOCKED>
<CREATORID>contactID</CREATORID>
<OWNERID>contactID</OWNERID>
<GROUPID>groupID</GROUPID>
<MODIFIERID>contactID</MODIFIERID>
<CREATIONDATE>YYYY-MM-DD hh:mm:ss</CREATIONDATE><!-- automatically filled by Sushee -->
<MODIFICATIONDATE>YYYY-MM-DD hh:mm:ss</MODIFICATIONDATE><!-- automatically filled by Sushee -->
<API>{dropbox,twitter,linkedin, ...}</API>
<DENOMINATION>text</DENOMINATION>
<LOGIN>text</LOGIN>
<TOKEN>text</TOKEN>
<TOKEN_SECRET>text</TOKEN_SECRET>
<AUTHORIZATION_STATE>{waiting,requested,authorized,disabled,revoked}</AUTHORIZATION_STATE>
<PUBLIC>W,R,0</PUBLIC>
</INFO>
</WEBACCOUNT>
paramètres
API: The webaccount type. Has to be defined in the WEBAPI list.
DENOMINATION: A text describing what this account is.
LOGIN: Optional. Indicates the login for the service. Usually not used, access is implemented through OAuth authentication which uses TOKEN and TOKEN_SECRET to identify the user. Its more secure than saving the real login and password, and can be revoked anytime by the user.
TOKEN: an identifier equivalent to a login to the service, but revokable at anytime.
TOKEN_SECRET: equivalent to a password to the service. Its used to sign any requests to the service, ensuring the security of the communication.
AUTHORIZATION_STATE: the webaccount status. Its starts by being stated 'waiting' for authorization. During the authorization process, it becomes 'requested' to finally become 'authorized' when the access is granted. It can be 'disabled' at anytime to temporarily suspend its use. If you want to definitely terminate its use, you can set it as 'revoked' and the tokens will be erased from the database.
Describes and facilitates the access to a distant service. Dropbox, Twitter and LinkedIn are supported natively. Any OAuth service should be easy to implement (see WEBAPI for details).
An access is first created and then authorized, using the <AUTHORIZE><WEBACCOUNT> command. This command redirects you to the distant service, which should you ask you to identify. Then the serivce redirects the user to your server which saves the TOKEN and TOKEN_SECRET intended to securely access this service. These tokens are saved once and allow you to access the service indefinitely (unless the access is revoked).
When the webaccount is authorized it can be called using the <CALL><WEBACCOUNT> command.
exemples
<CREATE>
<WEBACCOUNT>
<INFO>
<DENOMINATION>My twitter account</DENOMINATION>
<API>twitter</API>
</INFO>
</WEBACCOUNT>
</CREATE>
<AUTHORIZE>
<WEBACCOUNT ID="2"></WEBACCOUNT>
</AUTHORIZE>
<CALL>
<WEBACCOUNT ID="2">
<POSTMESSAGE>
<TEXT>Hello twitter world !</TEXT>
</POSTMESSAGE>
</WEBACCOUNT>
</CALL>
Voir aussi :
WEBAPI
Describes a webservice which offers a public API
AUTHORIZE WEBACCOUNT
Starts the process to get an oauth access to a distant webservice
CALL WEBACCOUNT
Calls a webservice method