Únete a la comunidad

Forma parte de esta comunidad y participa en las decisiones sobre el futuro de Librecraft

  1. Este sitio usa cookies técnicas. Learn More.

Documentación API

Tema en 'Reglas y tutoriales' comenzado por Kudo, 11 de Febrero de 2023.

Usuarios viendo el post (Usuarios: 0, Invitados: 0)

Estado del tema:
No está abierto para más respuestas.
  1. Kudo

    Staff Administrador/a global Equipo técnico Verificado/a

    Se incorporó:
    14 de Junio de 2017
    Mensajes:
    15.202
    Puntos de trofeos:
    523
    Ratings:
    +10.855
    IGN:
    Librecraft
    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ódigoInformación
    200Respuesta OK
    201Ejecutado con éxito
    204Sin resultados para la consulta
    209Sin resultados, devuelve valores por defecto
    400Solicitud incorrecta
    403Sin permisos o autentificación
    404Endpoint desconocido
    429 Solicitudes excedidas el uso aceptable
    500Error del servidor al procesar
    503Fuera del servicio
    2. Estructura de respuestas

    2.1. Estructura general de respuestas


    CampoTipoDescripción
    unixintFecha de respuesta de la solicitud / fecha de los datos en segundos.
    cachedbooleanSi los datos provienen de caché
    statusintRespuesta de la API
    msgstringInformación adicional
    dataarrayContenido 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

    CampoTipoDescripción
    idintNúmero del juego, no relevante
    gamestringNombre interno normalizado (por ejemplo para urls)
    gamenamestringNombre estilizado para uso público
    gamedescstringInformación breve del modo de juego
    gameaboutstringInformación extendida sobre el modo de juego
    gameshortstringCódigo interno del juego, relevante para consultas
    gameheaderstringVariables públicas de las estadísticas separadas por comas
    gamevarsstringVariables internas de las estadísticas separadas por comas
    playercolumnstringNombre de la variable del nombre de jugador
    faiconsstringIconos para acompañar a las variables de las estadísticas separadas por comas
    foroidstringURL para el foro de Librecraft (https://librecraft.com/foro/secciones/xxxxxx). Si es "0" debe utilizarse el campo "game".
    defaultsortstringIndica la posición del array donde empiezan las variables de estadísticas frente a otras variables de gamevars (generalmente el nombre)
    urlvideostringID de la lista de youtube de videos recomendados para ese juego
    ordersortintOrden en la lista de modos de juego o en el perfil
    enabledint0 - no mostrar
    1 - si mostrar
    gametype enumminijuego - 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

    CampoTipoDescripciónRequeridoDefecto
    jugadorStringNombre 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

    CampoTipoDescripciónRequeridoDefecto
    juegoStringCódigo interno "gameshort"Si-
    ordenintVariable 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.No1
    pageintPágina de los datos. Probablemente capado a un máximo de páginas.No1
    limitintMáximo de datos a recuperar. Actualmente siempre devuelve 50.No50
    3.4. Obtener SKIN

    GET /

    3.2.1 Parámetros de consulta

    CampoTipoDescripciónRequeridoDefecto
    jugadorStringNombre 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.
     
    • Divertido Divertido x 2
    • Me encanta Me encanta x 1
    • List
Estado del tema:
No está abierto para más respuestas.