Developers

Authentication API

authenticate_api


URL:

https://api.msgme.com/v1/authenticate/authenticate_api

METHOD:

Post

DESCRIPTION:

Allows retrieval of a temporary token that is used for subsequent API requests to Msgme's API services.

The tokens have a limited lifetime period of 24 hours. When the token expires an apiError response is returned, at which point a new access token must be requested for subsequent requests.

PARAMETERS:

Parameter Description
apiKey The API access key that was assigned by Msgme.
accountName Developer account username, NOT the Msgme account username.


API REQUEST:

NOTE: The authentication URL is SSL encrypted HTTPS

	<?xml version="1.0" encoding="UTF-8"?>
	<apiRequest>
		<authenticateAPI>
			<apiKey>[Msgme assigned API key]</apiKey>
			<accountName>[developer account name]</accountName>
			<destination>[redirect URL]</destination>
		</authenticateAPI>
	</apiRequest>

API RESPONSE:

	<?xml version="1.0" encoding="UTF-8"?>
	<apiResponse status="[status text]" statusCode="[status code]">
		<authToken>[your temporary token]</authToken>
	</apiResponse>


EXAMPLE USAGE:


REQUEST:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiRequest>
			<authenticateAPI>
				<apiKey>0e9ace1582fbb754dfe7f4e11f572bf5273f3c69</apiKey>
				<accountName>bob_foo</accountName>
			</authenticateAPI>
		</apiRequest>

RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="OK" statusCode="200">
			<authToken>vi2rqp89u21p2g427qernkd8m4</authToken>
		</apiResponse>