Difference between revisions of "Myinfo"
| Line 1: | Line 1: | ||
[[Category:API]] | [[Category:API]] | ||
| − | '''Implementation Status:''' [[Planned]]<br/> | + | '''Implementation Status:''' [[Planned(API Implementation Status)|Planned]]<br/> |
'''URI:''' https://api.kag2d.com/me<br/> | '''URI:''' https://api.kag2d.com/me<br/> | ||
'''HTTP Verbs Supported:''' GET<br/> | '''HTTP Verbs Supported:''' GET<br/> | ||
| Line 18: | Line 18: | ||
| − | '''Potential [[Future Features]]:''' | + | '''Potential [[API Feature Planning|Future Features]]:''' |
* HTTP PUT support for editing account information | * HTTP PUT support for editing account information | ||
* retrieval of additional account information | * retrieval of additional account information | ||
Revision as of 15:57, 4 March 2012
Implementation Status: Planned
URI: https://api.kag2d.com/me
HTTP Verbs Supported: GET
Response Type: JSON dictionary
HTTP Auth Required: Yes
This page provides self identity information. This is useful for getting the properly cased username and account status while at the same time performing basic authentication (such as when the client first opens).
Warning: This is intended for internal use only. 3rd parties using authentication and security-related API calls is highly discouraged. See this warning for more information.
Information returned to this call includes (key - description:
- username - the properly cased/formatted username on record
- accountStatus - see Account Status for possible values
No information will be returned if authentication fails. Authentication for this call will succeed even if the account is banned or inactive, as the main intention of this call is to perform username/password authentication and discover account problems.
Potential Future Features:
- HTTP PUT support for editing account information
- retrieval of additional account information
