Help Center > Voobly Developer Center > External API Documentation
External API Documentation

You can also view this page in the following Languages
englishn.pngspanishg.png

Contents:

English



Introduction

These APIs expose the ability to an external website to pull data out of Voobly. E.g.: A website might want to display the top 10 rated users on a particular ladder.

As explained in Developer Membership Types an access key is required for use with this APIs. For more information on that topic please review that page

API Documentation

The following list of APIs is a limited subset of we eventually plan to expose (recorded games, team information, etc). The easiest way to get something added here if you want it is to request it on the forums.

All the APIs are located at a path like a following. Not that they all take the developer key as a parameter.
http://www.voobly.com/api/apiname?key=XXXXXXXXXXXXXX

validation

Checks whether the developer key is valid

Example URI:
http://www.voobly.com/api/validate?key=XXXXXXXXXXXXXX

Example output:
valid-key

user/$userid

Get information on a user

Example URI:
http://www.voobly.com/api/user/23?key=XXXXXXXXXXXXXX

Example output:
uid,display_name,name,account_created,last_login,****,nationid,bday,bmonth,byear,level,nation,imagelarge,imagesmall,tid
23,Elusive,Elusive,1182149865,1255417337,0,ca,1,1,1950,29,Canada,/files/view/7068/3zy8h2kp3qq5ed3is2c37nw00uw3noyo,/files/view/65009/w57tdcefdmhsz7uvc4brqxyz8dpe0tgo,


ladder/$ladderid

Get ladder information. The following example spews out the top 40 ranked players. To get a specific player add &uid=123 to the URI where 123 is the user (example #2). Other extended features:
Example URI:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX

Example output:
rank,uid,display_name,rating,wins,losses,streak

Example URI #2:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX&uid=23

Example output #2:
rank,uid,display_name,rating,wins,losses,streak
1,23,Elusive,1679,26,15,1

finduser/$displayname

Lookup a uid from a display name

Example URI:
http://www.voobly.com/api/finduser/elusive?key=XXXXXXXXXXXXXX

Example output:
uid
23


findusers/$displayname,$displayname2,$displayname3,...

Lookup a list of userids from a list display names

Example URI:
http://www.voobly.com/api/finduser/elusive,someuser,xmx_elite?key=XXXXXXXXXXXXXX

Example output:
name,uid
elusive,1
someuser,
xmx_elite,17


In the above example elusive and xmx_elite are valid users names. Whereas, someuser is not.


lobbies/$gameid

Lookup a list of lobbies for a game

Example URI:
http://www.voobly.com/api/lobbies/13?key=XXXXXXXXXXXXXX

Example output:
lobbyid,name,players_online,max_players,ladders

Example Usage

TODO - Post a sample PHP script

Spanish



Documentación de la API externa


Introducción


Estas APIs expone la capacidad de un sitio web externo para extraer los datos fuera de voobly. Por ejemplo: un sitio web que desee mostrar el top 10 de los usuarios de una determinada escalera.

Como se ha explicado en Developer Membership Types una clave de acceso es necesaria para el uso de estas APIs. Para obtener más información sobre este tema por favor, re-lea esa página

API Documentación


La siguiente lista de APIs es un subconjunto limitado de lo que eventualmente vamos a exponer (Partidas grabados, información sobre el equipo, etc.) La manera más fácil de obtener que algo mas se añada aquí, si desea que se haga, pon una solicitud en los foros.

Todas las APIs están ubicados en una ruta como la siguiente, lo cual no significa que todos ellos tienen la clave de desarrollo como un parámetro.

http://www.voobly.com/api/apiname?key=XXXXXXXXXXXXXX

Validación

Comprueba si la clave del desarrollador es válida.

Ejemplo URI:
http://www.voobly.com/api/validate?key=XXXXXXXXXXXXXX

Ejemplo de salida:
valid-key

user/$userid


Obtener información sobre un usuario.
Ejemplo URI:
http://www.voobly.com/api/user/23?key=XXXXXXXXXXXXXX

Ejemplo de salida:
uid,display_name,name,account_created,last_login,****,nationid,bday,bmonth,byear,level,nation,imagelarge,imagesmall,tid
23,Elusive,Elusive,1182149865,1255417337,0,ca,1,1,1950,29,Canada,/files/view/7068/3zy8h2kp3qq5ed3is2c37nw00uw3noyo,/files/view/65009/w57tdcefdmhsz7uvc4brqxyz8dpe0tgo,

ladder/$ladderid


Obtener información escalera. El ejemplo siguiente sabrá los 40 mejores jugadores clasificados.
Para obtener un jugador en específico agregar &uid=123 a la URI donde 123 es el usuario (ejemplo #2). Otras características:

Example URI:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX

Ejemplo Salida:
rank,uid,display_name,rating,wins,losses,streak
Ejemplo URI #2:
http://www.voobly.com/api/ladder/10?key=XXXXXXXXXXXXXX&uid=23

Ejemplo salida #2:
rank,uid,display_name,rating,wins,losses,streak
1,23,Elusive,1679,26,15,1

finduser/$displayname

buscar un uid de un nombre a mostrar

Ejemplo URI:
http://www.voobly.com/api/finduser/elusive?key=XXXXXXXXXXXXXX

Ejemplo salida:
uid
23


findusers/$displayname,$displayname2,$displayname3,...

Buscar una lista de id de la lista nombres de visualización.

Ejemplo URI:
http://www.voobly.com/api/finduser/elusive,someuser,xmx_elite?key=XXXXXXXXXXXXXX

Ejemplo salida:
name,uid
elusive,1
someuser,
xmx_elite,17

En el ejemplo anterior elusive and xmx_elite son nombres de usuarios válidos En cambio, someuser alguien no lo es.

lobbies/$gameid

Buscar una lista de los grupos de juego.

Ejemplo URI:
http://www.voobly.com/api/lobbies/13?key=XXXXXXXXXXXXXX

Ejemplo de salida:
lobbyid,name,players_online,max_players,ladders
Ejemplo de Uso

TODO - Postear un ejemplo de script de PHP


Last updated on 15 February 2015 - 5:20 pm by 2394823
1 User(s) are reading this document (過去30分以内)
0 members, 1 guests

Şu an en popüler:
Geçen haftaki en aktif konular:
NPL IPL MS (5 gönderi)