UDP API Definition: Difference between revisions

Jump to navigation Jump to search
(0.03b)
mNo edit summary
Line 2: Line 2:
== General Information ==
== General Information ==
'''Author:''' [[User:Exp|Exp]] & [[User:Epoximator|Epoximator]]<br>
'''Author:''' [[User:Exp|Exp]] & [[User:Epoximator|Epoximator]]<br>
'''Version:''' 0.03 - 13.01.2006 <br>
'''Version:''' 0.03b - 23.07.2006 <br>
'''Version number used for protover parameter:''' "3"
'''Version number used for protover parameter:''' "3"


Line 49: Line 49:
*** 600 INTERNAL SERVER ERROR
*** 600 INTERNAL SERVER ERROR
*** 601 ANIDB OUT OF SERVICE - TRY AGAIN LATER
*** 601 ANIDB OUT OF SERVICE - TRY AGAIN LATER
*** 602 SERVER BUSY - TRY AGAIN LATER
** Additional return codes for all commands that '''require login''':
** Additional return codes for all commands that '''require login''':
*** 501 LOGIN FIRST
*** 501 LOGIN FIRST
Line 64: Line 65:
}}
}}


=== Server / UDP Connection: ===
=== Server / UDP Connection ===
The Client has to send data packets to:
The Client has to send data packets to:
* '''Server:''' api.anidb.info
* '''Server:''' api.anidb.info
Line 395: Line 396:
Group of commands used to administrate your buddylist.
Group of commands used to administrate your buddylist.


=== BUDDYADD ===
=== BUDDYADD: Add a user to Buddy List ===
'''Command String:'''
'''Command String:'''
* BUDDYADD uid={int4 buddy uid}
* BUDDYADD uid={int4 buddy uid}
Line 406: Line 407:
----
----


=== BUDDYDEL ===
=== BUDDYDEL: Remove a user from Buddy List ===
'''Command String:'''
'''Command String:'''
* BUDDYDEL uid={int4 buddy uid}
* BUDDYDEL uid={int4 buddy uid}
Line 415: Line 416:
----
----


=== BUDDYACCEPT ===
=== BUDDYACCEPT: Accept user as Buddy ===
'''Command String:'''
'''Command String:'''
* BUDDYACCEPT uid={int4 user uid}
* BUDDYACCEPT uid={int4 user uid}
Line 425: Line 426:
----
----


=== BUDDYDENY ===
=== BUDDYDENY: Deny user as Buddy ===
'''Command String:'''
'''Command String:'''
* BUDDYDENY uid={int4 buddy uid}
* BUDDYDENY uid={int4 buddy uid}
Line 435: Line 436:
----
----


=== BUDDYLIST ===
=== BUDDYLIST: Retrieve Buddy List ===
'''Command String:'''
'''Command String:'''
* BUDDYLIST startat={int2 start at #}
* BUDDYLIST startat={int2 start at #}
Line 450: Line 451:
----
----


=== BUDDYSTATE ===
=== BUDDYSTATE: Retrieve Buddy States===
'''Command String:'''
'''Command String:'''
* BUDDYSTATE startat={int2 start at #}
* BUDDYSTATE startat={int2 start at #}
Line 735: Line 736:


----
----
=== PRODUCER ===
=== PRODUCER: Retrieve Producer Data ===
'''Command String:'''<br>
'''Command String:'''<br>
by id
by id
Line 871: Line 872:


----
----
=== VOTE: Vote for a specifed anime, episode or group ===
=== VOTE: Vote for specified anime/episode/group ===
'''Command String:'''<br>
'''Command String:'''<br>
by id
by id
Line 927: Line 928:
----
----


=== ENCRYPT ===
=== ENCRYPT: Start Encrypted Session ===
Will cause all future messages from the server, except the first (the reply to the ENCRYPT command itself), to be encrypted (128 bit [http://en.wikipedia.org/wiki/Advanced_Encryption_Standard AES]). The client will also have to encrypt all future requests sent to the server. All non-encrypted messages will be discarded by the server. The encryption key is the [http://en.wikipedia.org/wiki/MD5 MD5] hash of a special ''API Password'' (defined in the users profile) concatenated with the salt string as given in the reply to the ENCRYPT message. A normal AUTH message is still necessary to authenticate and should follow the ENCRYPT command once the API has acknowledged the encryption.
Will cause all future messages from the server, except the first (the reply to the ENCRYPT command itself), to be encrypted (128 bit [http://en.wikipedia.org/wiki/Advanced_Encryption_Standard AES]). The client will also have to encrypt all future requests sent to the server. All non-encrypted messages will be discarded by the server. The encryption key is the [http://en.wikipedia.org/wiki/MD5 MD5] hash of a special ''API Password'' (defined in the users profile) concatenated with the salt string as given in the reply to the ENCRYPT message. A normal AUTH message is still necessary to authenticate and should follow the ENCRYPT command once the API has acknowledged the encryption.


Line 950: Line 951:
----
----


=== ENCODING ===
=== ENCODING: Change Encoding for Session ===
Sets preferred [http://en.wikipedia.org/wiki/Character_encoding encoding] per session.
Sets preferred [http://en.wikipedia.org/wiki/Character_encoding encoding] per session.


Line 984: Line 985:
----
----


=== USER: Retrieve user uid ===
=== USER: Retrieve User UID ===
'''Command String:'''
'''Command String:'''
* USER user={str user name}
* USER user={str user name}
Line 997: Line 998:
----
----


=== UPTIME ===
=== UPTIME: Retrieve Server Uptime ===
'''Command String:'''
'''Command String:'''
* UPTIME
* UPTIME
Line 1,004: Line 1,005:
* 208 UPTIME
* 208 UPTIME
: {int4 udpserver uptime in milliseconds}
: {int4 udpserver uptime in milliseconds}
----
=== VERSION: Retrieve Server Version ===
'''Command String:'''
* VERSION
'''Possible Replies:'''
* 998 VERSION
: {str server version}


----
----
Line 1,197: Line 1,208:
<pre>
<pre>
0.03b - 23.07.2006
0.03b - 23.07.2006
BUDDY*, PRODUCER, ENCRYPT, ENCODING, USER commands added
BUDDY*, PRODUCER, ENCRYPT, ENCODING, USER, VERSION commands added
AUTH, NOTIFY, ANIME, FILE commands extended
AUTH, NOTIFY, ANIME, FILE commands extended
STATS and TOP commands disabled due performance issues
STATS and TOP commands disabled due performance issues
Retrieved from "https://wiki.anidb.net/UDP_API_Definition"