Bienvenido a Internet BBS/IB
Documentación API

Introducción

El API de BaI se encuentra en http://bienvenidoainternet.org/cgi/api. Los parámetros se envían como datos GET y el servidor retorna un documento JSON con los datos documentados a continuación.

En el documento JSON siempre existirá el campo state (String) que indica el estado del pedido.

Métodos

api/boards

Devuelve una lista de todos los boards públicos disponibles en BaI.

Salidas

Nombre Tipo Descripción
board_type Number Tipo de board. 0 = IB; 1 = BBS
dir String Directorio en donde se encuentra el board.
name String Nombre completo del board.
allow_images Number Si permite subida de archivos al crear un hilo. 0 = No; 1 = Sí
allow_image_replies Number Si permite subida de archivos al responder a un hilo. 0 = No; 1 = Sí
maxsize Number Tamaño máximo permitido al subir un archivo (en kilobytes).

api/lastage

Devuelve una lista de los últimos hilos recientemente activos en BaI (todos los boards).

Parámetros

Nombre Tipo Descripción
time Number Tiempo UNIX del hilo más antiguo a mostrar.
limit Number Cantidad de registros a mostrar. (Máx: 50)

Salidas

Nombre Tipo Descripción
dir String Directorio del board en donde se encuentra el hilo.
board_fulln String Nombre del board.
board_name String Abreviación del nombre del board en 3 caracteres.
board_type Number Tipo de board. 0 = IB; 1 = BBS
timestamp Number Tiempo UNIX del hilo (equivalente al tiempo del post creador del hilo).
bumped Number Tiempo UNIX de cuándo el hilo fue bumpeado.
timestamp_formatted String Fecha formateada de bumped.
id Number ID del hilo (equivalente al ID del post creador del hilo).
content String Asunto del hilo o primeros 100 caracteres del mensaje en caso de no tener asunto.
length Number Cantidad de posts en el hilo.
url String URL del hilo (sin dominio).

api/last

Devuelve una lista de los últimos posts que han sido enviados a BaI (todos los boards).

Parámetros

Nombre Tipo Descripción
since Number Tiempo Unix del post más antiguo a mostrar.
limit Number Cantidad de registros a mostrar. (Máx: 50)

Salidas

Nombre Tipo Descripción
posts Array<Post> Lista de posts

api/list

Devuelve una lista de los hilos de un board en orden de posteo descendiente. Opcionalmente puede incluir las últimas respuestas de cada hilo.

Parámetros

Nombre Tipo Descripción
dir* String Directorio del board
replies Number Cantidad de respuestas a mostrar, 0 = no mostrar
offset Number Registro desde cual empezar
limit Number Cantidad de registros a mostrar (Max: 30 si replies > 0)

Salidas

Nombre Tipo Descripción
threads Array<Thread> Lista de hilos

api/thread

Devuelve un hilo determinado con sus posts.

Parámetros

Nombre Tipo Descripción
dir* String Directorio del board
id* Number ID del hilo (equivalente al ID del post creador del hilo)
offset Number Post desde cual empezar
limit Number Cantidad de posts a mostrar

Salidas

Nombre Tipo Descripción
id Number ID del hilo (equivalente al ID del post creador del hilo)
timestamp Number Tiempo UNIX de la creación del hilo
subject String Asunto del hilo
total_replies Number Respuestas totales del hilo (sin contar OP)
posts Array<Post> Lista de posts

Estructuras

Post

Estructura que contiene información de un mensaje determinado.

Datos

Nombre Tipo Descripción
id Number ID del mensaje
IS_DELETED Number Indica si el post ha sido eliminado o no. 0 = No eliminado, 1 = Eliminado por usuario, 2 = Eliminado por staff. Si el post ha sido eliminado el resto de los campos no son enviados.
timestamp Number Tiempo UNIX del mensaje
timestamp_formatted String Fecha formateada del mensaje (como mostrada en web).
parentid Number El ID del hilo al que este mensaje pertenece; 0 = es OP
name String Nombre del autor
tripcode String Tripcode del mensaje; String vacío = no tiene tripcode
email String Campo de e-mail
subject String Asunto del mensaje
message String Contenido del mensaje
file String Nombre de archivo del archivo enviado; String vacío = no tiene archivo
file_size Number Tamaño en bytes del archivo; 0 = no tiene archivo
image_height Number Alto en pixeles de imagen; 0 = no tiene imagen
image_width Number Ancho en pixeles de imagen; 0 = no tiene imagen
thumb String Nombre de archivo de la imagen miniatura; String vacío = no hay miniatura
thumb_height Number Alto de la imagen miniatura; 0 = no hay miniatura
thumb_width Number Ancho de la imagen minatura; 0 = no hay miniatura

Thread

Estructura que contiene la información de un hilo. Son los mismos campos que Post, más los siguientes:

Datos

Nombre Tipo Descripción
total_replies Number Número total de respuestas (sin contar OP)
total_files Number Número total de archivos en el hilo
locked Number Estado del hilo, 0 = normal, 1 = cerrado, 2 = permasage
replies Array<Post> Respuestas en el hilo, si aplica.