Api Explorer
{{ jsonMessage | json }}
help
Guía de uso del API
Los siguientes recursos están expuestos por endpoints con su mismo nombre:
| Endpoint | Recurso |
|---|---|
fairs |
Ferias registradas en el sistema |
fairEvents |
Eventos registrados en las ferias del sistema |
categories |
Categorías registradas en el sistema |
maps |
Mapas de ferias registrados en el sistema |
stands |
Stands participantes en las ferias del sistema |
news |
Noticias registradas en las ferias del sistema |
sponsors |
Patrocinadores de las ferias del sistema |
speakers |
Expositores registrados a los eventos del sistema |
comments |
Comentarios registrados a las noticias del sistema |
Cada endpoint permite ser consultado directamente, o permite consultar un recurso en
específico proporcionando un id al url (ejemplo: fairs/1 regresará solo la feria con id de 1).
Toda consulta realizada mediante el verbo HTTP GET puede llevar los siguientes
parámetros mediante un URL query, los cuales modificaran el resultado mostrado:
| Parámetro | Descripción |
|---|---|
include=resource,resource2... |
Incluirá información de los recursos especificados que estén relacionados con el recurso original consultado. |
sort=field1,field2... |
Ordenará los resultados de acuerdo a los campos especificados de manera ascendente.
El orden tomará prioridad de izquierda a derecha para los campos proporcionados, y para ordenar de manera descendiente, especifique el símbolo - antes del parámetro.
|
page[limit]=pl&page[cursor]=pc |
Mostrará solo un set de los resultados obtenidos, empezando desde el elemento
en la posición pl de la lista hasta pc
elementos más adelante (offset). La respuesta incluirá información del offset y límite actual.
|
Cuando un recurso está relacionado con múltiples instancias de otros recursos, estos pueden ser
consultados agregando el nombre del recurso relacionado al url de la consulta por id.
Ejemplo: Una feria está relacionada a múltiples eventos, por lo cual se puede realizar una consulta a
fairs/1/fairEvents para obtener todos los eventos correspondientes a la feria con id de 1.
Las relaciones disponibles (en formato recurso/{id}/sub-recurso) son:
| Recurso | Sub-Recursos |
|---|---|
fairs |
sponsors
maps
categories
fairEvents
news
stands
|
fairEvents |
speakers
attendingUsers
categories
|
categories |
fairEvents
|
news |
comments |