Espacios

Notas
Nivel experto
La clave de API debe enviarse como un token Bearer en el encabezado de autorización de la solicitud. Obtén tu clave de API.
Lista

Punto final de la API:

GET 
http://link.platform.cl/api/v1/spaces

Ejemplo de solicitud: 

curl --location --request GET 'http://link.platform.cl/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
search
opcional string
La consulta de búsqueda.
search_by
opcional string
Buscar por. Los valores posibles son: name para Nombre. Predeterminado: name.
sort_by
opcional string
Ordenar por. Los valores posibles son: id para Fecha de creación, name para Nombre. Predeterminado: id.
sort
opcional string
Ordenar. Los valores posibles son: desc para Descendente, asc para Ascendente. Predeterminado: desc.
per_page
opcional int
Resultados por página. Los valores posibles son: 10, 25, 50, 100. Predeterminado: 10.
Mostrar

Punto final de la API:

GET 
http://link.platform.cl/api/v1/spaces/{id}

Ejemplo de solicitud: 

curl --location --request GET 'http://link.platform.cl/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Almacenar

Punto final de la API:

POST 
http://link.platform.cl/api/v1/spaces

Ejemplo de solicitud: 

curl --location --request POST 'http://link.platform.cl/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parámetro
Tipo
Descripción
name
requerido string
El nombre del espacio.
color
opcional integer
El código de color. Los valores posibles son: 1, 2, 3, 4, 5, 6. Predeterminado: 1.
Actualizar

Punto final de la API:

PUT PATCH 
http://link.platform.cl/api/v1/spaces/{id}

Ejemplo de solicitud: 

curl --location --request PUT 'http://link.platform.cl/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
name
opcional string
El nombre del espacio.
color
opcional integer
El código de color. Los valores posibles son: 1, 2, 3, 4, 5, 6.
Eliminar

Punto final de la API:

DELETE 
http://link.platform.cl/api/v1/spaces/{id}

Ejemplo de solicitud: 

curl --location --request DELETE 'http://link.platform.cl/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'