Skip to content
Alban LEROUX edited this page Oct 3, 2011 · 7 revisions

API

auth.request

Request for a authentification token.

no grant access required

Request example

GET http://example.com/api/get/auth.request/json/?username=guest
{
	"method"  : "auth.request",
	"request" :
	{
		"username" : "guest"
	}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<method>auth.token</method>
	<request>
		<username>guest</username>
	</refresh>
</xml>

Response example

{
	"status"   : "valid",
	"response" : 
	{
		"lifetime"  : 600,
		"challenge" : "8b863651d51f3000226aa9a628df4ee8"
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<status>valid</status>
	<response>
		<lifetime>600</lifetime>
		<token>8b863651d51f3000226aa9a628df4ee8</token>
	</response>
</xml>

Arguments

  • username: the user name

Return Value

  • lifetime: the challenge and token lifetime
  • challenge: the challenge

Clone this wiki locally