Espaços

Notes
Especialista
A chave de API deve ser enviada como um token de portador no cabeçalho de autorização da solicitação. Obtenha sua chave de API.
List

API endpoint:

GET 
https://boky.in/api/v1/spaces

Exemplo de solicitação: 

curl --location --request GET 'https://boky.in/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
optional string
The search query.
search_by
optional string
Procurar por. Possible values are: name for Nome. Defaults to: name.
sort_by
optional string
Ordenar por. Possible values are: id for Data Criada, name for Nome. Defaults to: id.
sort
optional string
Ordenar. Possible values are: desc for Descendente, asc for Ascendente. Defaults to: desc.
per_page
optional int
Resultados por página. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://boky.in/api/v1/spaces/{id}

Exemplo de solicitação: 

curl --location --request GET 'https://boky.in/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://boky.in/api/v1/spaces

Exemplo de solicitação: 

curl --location --request POST 'https://boky.in/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parâmetro
Tipo
Descrição
name
required string
The space name.
color
optional integer
The color code. Possible values are: 1, 2, 3, 4, 5, 6. Defaults to: 1.
Update

API endpoint:

PUT PATCH 
https://boky.in/api/v1/spaces/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://boky.in/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
name
optional string
The space name.
color
optional integer
The color code. Possible values are: 1, 2, 3, 4, 5, 6.
Deletar

API endpoint:

DELETE 
https://boky.in/api/v1/spaces/{id}

Exemplo de solicitação: 

curl --location --request DELETE 'https://boky.in/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'