API – Documentación


Esta es la referencia completa de nuestro API, por favor use este enlace para tener el URL del “Endpoint” e instrucciones adicionales para conectase a nuestro servicio REST.

Summary

Tag: Consultar

Métodos para la consulta de contenidos alojados en el Hub

Operation Description
GET /temas
GET /tipos
GET /publicaciones
GET /autores

Tag: Contribuir

Métodos para la contribución de contenidos

Operation Description
POST /publicar
POST /actualizar

Paths

POST /actualizar

Tags:
Contribuir

Permite actualizar una publicación ya alojada en el HUB, tener en cuenta que solo puede actualizar publicaciones que usted, como socio, ha registrado en el HUB

token

Llave o token asignado al usuario, sin esto no es posible efectuar la función.

formData string

publicacion

Publicación en formato JSON según las especificaciones necesarias, para este caso el parámetro ID es obligatorio

formData string

application/json

200 OK

Resultado de la petición

422 Unprocessable Entity

La validación del objeto de entrada no ha sido satisfactoria, información adicional en la respuesta

GET /autores

Tags:
Consultar

Obtiene todos los autores/socios del HUB.

application/json

200 OK

Resultado de la petición

422 Unprocessable Entity

La validación del objeto de entrada no ha sido satisfactoria, información adicional en la respuesta

GET /publicaciones

Tags:
Consultar

Permite filtrar las publicaciones, similar a la sección 'Explorar' del HUB.

busqueda

Palabra clave o criterio de búsqueda.

query string

tipos

Tipos a incluir (slugs) separados por comas; el método devolverá las publicacioens que coincidan con tales tipos.

query string

temas

Temas a incluir (slugs) separados por comas; el método devolverá las publicacioens que coincidan con tales temas.

query string

autores

Ingrese los nombres de usuario de los autores separados por coma

query string

publicaciones_por_pagina

Cuántas publicaciones retornar por petición. Máximo 200.

query integer

pagina

Nro de página para extraer el contenido

query integer

application/json

200 OK

Resultado de la petición

422 Unprocessable Entity

La validación del objeto de entrada no ha sido satisfactoria, información adicional en la respuesta

POST /publicar

Tags:
Contribuir

Permite agregar una publicación al sistema

token

Llave o token asignado al usuario, sin esto no es posible efectuar la función.

formData string

publicacion

Publicación en formato JSON según las especificaciones necesarias (documentación dinámica incluida)

formData string

application/json

200 OK

Resultado de la petición

422 Unprocessable Entity

La validación del objeto de entrada no ha sido satisfactoria, información adicional en la respuesta

GET /temas

Tags:
Consultar

Obtiene todos los temas en el HUB de manera jerarquizada.

application/json

200 OK

Resultado de la petición

422 Unprocessable Entity

La validación del objeto de entrada no ha sido satisfactoria, información adicional en la respuesta.

GET /tipos

Tags:
Consultar

Obtiene todos los tipos en el HUB de manera jerarquizada.

application/json

200 OK

Resultado de la petición

422 Unprocessable Entity

La validación del objeto de entrada no ha sido satisfactoria, información adicional en la respuesta.

Schema definitions

MetaData:
object


Representa metadata de la publicación

NombreCampo:
string

Alias o nombre del campo de la metadata.

Valor:
string

Valor de la metadata.

Publicacion:
object


Estructura base de una publicación que puede importada o exportada en el Hub.

IdExterno:
number

Id de la publicación original, una publicación que viene de un sitio externo debe tener una ID para poder identificarlo en posteriores actualizaciones.

FechaRegistro:
string

La fecha en la que se realizó el registro de la publicación. Este es el registro de la publicación original, no la fecha en la que la publicación fue compartida al HUB. Formato válido 'Y-m-d H:i:s'

Titulo:
string

El título de la publicación.

Link:
string

El link permanente de la publicación en su sitio web de origen.

Resumen:
string

Texto de un párrafo que se usará para mostrar un previo del contenido.

Contenido:
string

Contenido de la publicación.

Imagen:
string

Url de la imagen representativa de la publicación.

TiposHub:
object[]

Tipos a los que estará vinculado.

TemasHub:
object[]

Temas a los que estará vinculado.

MetaData:
object[]

MetaData visible para la publicación

RespuestaAutor:


statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

data:
object

La tipificación depende del servicio

data:
SerialAutor

statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

RespuestaBase:
object


statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

data:
object

La tipificación depende del servicio

RespuestaPublicacion:


statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

data:
object

La tipificación depende del servicio

data:
SerialPublicacion

statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

RespuestaTema:


statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

data:
object

La tipificación depende del servicio

data:
SerialTema

statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

RespuestaTipo:


statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

data:
object

La tipificación depende del servicio

data:
SerialTipo

statusCode:
integer

Código HTTP de error

status:
string (string) , x ∈ {
success
,
fail
,
error

}

Status de la respuesta, la respuesta en error es fail y error

message:
string

Mensaje de la respuesta, en caso de fail y error aparece aquí la excepción

SerialAutor:
object


Contiene datos los autores registrados en el HUB.

Nombre:
string

Nombre del autor

Url:
string

Url del site del autor

UrlHub:
string

Url de la página del autor del site HUB

TotalPublicaciones:
integer

Número total de publicaciones del autor

SerialPublicacion:
object


Estructura base de una publicación que puede importada o exportada en el Hub.

IdExterno:
number

Id de la publicación original, una publicación que viene de un sitio externo debe tener una ID para poder identificarlo en posteriores actualizaciones.

FechaRegistro:
string

La fecha en la que se realizó el registro de la publicación. Este es el registro de la publicación original, no la fecha en la que la publicación fue compartida al HUB.

Titulo:
string

El título de la publicación.

Link:
string

El link permanente de la publicación en su sitio web de origen.

Resumen:
string

Texto de un párrafo que se usará para mostrar un previo del contenido.

Contenido:
string

Contenido de la publicación.

Slug:
string

Slug de la publicación.

Imagen:
string

Url de la imagen representativa de la publicación.

TiposHub:
object[]

Tipos a los que estará vinculado.

TemasHub:
object[]

Temas a los que estará vinculado.

MetaData:
object[]

MetaData visible para la publicación

SerialSubTema:
object


Contiene datos de los subtemas.

Nombre:
string

Nombre del subtema

Slug:
string

Slug del subtema

TotalDocumentos:
integer

Número total de documentos del subtema

SerialSubTipo:
object


Contiene datos de los subtipos.

Nombre:
string

Nombre del subtipo

Slug:
string

Slug del subtipo

TotalDocumentos:
integer

Número total de documentos del subtipo

SerialTema:
object


Contiene datos los temas y subtemas registrados en el HUB.

Nombre:
string

Nombre del tema

Slug:
string

Slug del tema

TotalDocumentos:
integer

Número total de documentos del tema

Temas:
object[]

Lista de subtemas

SerialTipo:
object


Contiene datos los tipos y subtipos registrados en el HUB.

Nombre:
string

Nombre del tipo

Slug:
string

Slug del tipo

TotalDocumentos:
integer

Número total de documentos del tipo

Tipos:
object[]

Lista de subtipos

Tema:
object


Representación de un tema (taxonomía para las publicaciones)

Slug:
string

Slug del tema.

Tipo:
object


Representación de un tipo (taxonomía para las publicaciones)

Slug:
string

Slug del tipo.

Cerrar