//[[restapi:start|RESTful API]]//

====== Register Twitter App ======

==== Overview ====

To post a message on your Twitter's timeline you will need a Twitter app, you could use the [[https://get.fabric.io|Twitter's fabric]] to do so. Once you have it you need to register it with the Campaign Manager to make it able to post messages in your name.
==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/registerTwitterApp/{instanceId}/{appName}/{twAppId}/{twAppSecret}/{redirectURL}/{publicKey}/{signature}

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| appName | Your Twitter App's name which will post your messages. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. |
| twAppId | Your Twitter App's identifier, if you don't know it you can check it using the [[https://dev.twitter.com|Twitter Developer Site]] |
| twAppSecret | Your Twitter App's secret, if you don't know it you can check it using the [[https://dev.twitter.com|Twitter Developer Site]] |
| redirectURL | The URL that users will be redirected to from Twitter after registration finished. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |
==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>registerTwitterApp</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| successful | Indicates if the registration was successful or not | <color blue>true</color> \\ <color red>false</color> |
| message | A human readable explanation | Text |