1,633
edits
UDP API Definition: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
mNo edit summary |
|||
| Line 180: | Line 180: | ||
* A '''506 INVALID SESSION''' means that either the session key parameter "s" was not provided with a command that requires it or the session key is no longer valid. The client should reissue an AUTH command. | * A '''506 INVALID SESSION''' means that either the session key parameter "s" was not provided with a command that requires it or the session key is no longer valid. The client should reissue an AUTH command. | ||
{{eyecatch|Note|A frontend shall expect 501 and 502 messages to be returned on ANY command.}}<br> | {{eyecatch|Note|A frontend shall expect 501 and 502 messages to be returned on ANY command.}}<br> | ||
{{eyecatch|Note|AniDB usernames are always | {{eyecatch|Note|AniDB usernames are always lower case and may only contain characters (a-z) and numbers (0-9).}} | ||
* The client should silently convert all entered usernames to | * The client should silently convert all entered usernames to lower case before sending them to the API. | ||
* The client should send the apiversion of the AnimeDB API version it supports as value of the protover parameter. | * The client should send the apiversion of the AnimeDB API version it supports as value of the protover parameter. | ||
* The client MAY NOT send anything but the version of the API Specs the author used to write the client! (as it is stated at the top of this file @ "Version number used for protover parameter") | * The client MAY NOT send anything but the version of the API Specs the author used to write the client! (as it is stated at the top of this file @ "Version number used for protover parameter") | ||
: The API will compare that value to it's own version of the API and if the version of the client is older the API will decide whether the changes were significant enough to deny the old client access to the DB. | : The API will compare that value to it's own version of the API and if the version of the client is older the API will decide whether the changes were significant enough to deny the old client access to the DB. | ||
* The clientname shall be a | * The clientname shall be a lower-case string containing only the chars ''a-z'' of ''4-16 chars'' length which identifies the client. (i.e. mykickassclient) | ||
* The clientversion shall be a number starting with 1, increased on every change in the client. | * The clientversion shall be a number starting with 1, increased on every change in the client. | ||
: clientname and clientversion might be used by the API to distinguish between different clients and client versions if that should ever become necessary. | : clientname and clientversion might be used by the API to distinguish between different clients and client versions if that should ever become necessary. | ||