Documentación API

Información sobre las respuestas de la API pública de Librecraft. Actualmente en fase de pruebas con acceso reservado para proyectos seleccionados por la administración.

0. Autenticación

Todas las solicitudes a la API deben contener el header "apikey" para identificarse. Asimismo, se rechazaran todas las conexiones que provengan de IPs no autorizadas.

1. Estados

Código	Información
200	Respuesta OK
201	Ejecutado con éxito
204	Sin resultados para la consulta
209	Sin resultados, devuelve valores por defecto
400	Solicitud incorrecta
403	Sin permisos o autentificación
404	Endpoint desconocido
429	Solicitudes excedidas el uso aceptable
500	Error del servidor al procesar
503	Fuera del servicio

2. Estructura de respuestas

2.1. Estructura general de respuestas

Campo	Tipo	Descripción
unix	int	Fecha de respuesta de la solicitud / fecha de los datos en segundos.
cached	boolean	Si los datos provienen de caché
status	int	Respuesta de la API
msg	string	Información adicional
data	array	Contenido de la respuesta. En caso de error, generalmente null aunque podría contener también información del error (p. ej. 503)

2.2. Estructura de información sobre el juego

Campo	Tipo	Descripción
id	int	Número del juego, no relevante
game	string	Nombre interno normalizado (por ejemplo para urls)
gamename	string	Nombre estilizado para uso público
gamedesc	string	Información breve del modo de juego
gameabout	string	Información extendida sobre el modo de juego
gameshort	string	Código interno del juego, relevante para consultas
gameheader	string	Variables públicas de las estadísticas separadas por comas
gamevars	string	Variables internas de las estadísticas separadas por comas
playercolumn	string	Nombre de la variable del nombre de jugador
faicons	string	Iconos para acompañar a las variables de las estadísticas separadas por comas
foroid	string	URL para el foro de Librecraft (https://librecraft.com/foro/secciones/xxxxxx). Si es "0" debe utilizarse el campo "game".
defaultsort	string	Indica la posición del array donde empiezan las variables de estadísticas frente a otras variables de gamevars (generalmente el nombre)
urlvideo	string	ID de la lista de youtube de videos recomendados para ese juego
ordersort	int	Orden en la lista de modos de juego o en el perfil
enabled	int	0 - no mostrar 1 - si mostrar
gametype	enum	minijuego - modos arena/rondas con estadísticas modalidad - experiencias de juego duraderas

3. Endpoints

3.1. Obtener listado de juegos

GET /

3.2. Obtener estadísticas de jugador

GET /

3.2.1 Parámetros de consulta

Campo	Tipo	Descripción	Requerido	Defecto
jugador	String	Nombre de jugador. Formato "[A-Za-z0-9_]{3,16}"	Si	-

3.3. Obtener mejores jugadores en modo de juego

GET /

3.3.1 Parámetros de consulta

Campo	Tipo	Descripción	Requerido	Defecto
juego	String	Código interno "gameshort"	Si	-
orden	int	Variable por la que queremos ordenar. Sería la posición que ocupa en el array de "gamevars" correspondiendo la 0 generalmente al nombre del usuario.	No	1
page	int	Página de los datos. Probablemente capado a un máximo de páginas.	No	1
limit	int	Máximo de datos a recuperar. Actualmente siempre devuelve 50.	No	50

3.4. Obtener SKIN

GET /

3.2.1 Parámetros de consulta

Campo	Tipo	Descripción	Requerido	Defecto
jugador	String	Nombre de jugador. Formato "[A-Za-z0-9_]{3,16}"	Si	-

Esta documentación se ofrece únicamente para aprovechamiento de las personas con acceso a la API pública. Por el momento reservada a proyectos seleccionados por la administración.