Espaços

Notas
Nível de especialista
A chave API deve ser enviada como um token de portador no cabeçalho de autorização da solicitação. Obtenha sua chave API.
Lista

Ponto de extremidade da API:

GET 
https://yours.com.br/api/v1/spaces

Exemplo de solicitação: 

curl --location --request GET 'https://yours.com.br/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
Consulta de pesquisa.
search_by
opcional string
Pesquisar por. Os valores possíveis são: name para Nome. O padrão é: name.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, name para Nome. O padrão é: id.
sort
opcional string
Organizar. Os valores possíveis são: desc para Descendente, asc para Ascendente. O padrão é: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. O padrão é: 10.
Mostrar

Ponto de extremidade da API:

GET 
https://yours.com.br/api/v1/spaces/{id}

Exemplo de solicitação: 

curl --location --request GET 'https://yours.com.br/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Loja

Ponto de extremidade da API:

POST 
https://yours.com.br/api/v1/spaces

Exemplo de solicitação: 

curl --location --request POST 'https://yours.com.br/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
obrigatório string
Nome.
color
opcional integer
Cor. Os valores possíveis são: 1, 2, 3, 4, 5, 6. O padrão é: 1.
Atualizar

Ponto de extremidade da API:

PUT PATCH 
https://yours.com.br/api/v1/spaces/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://yours.com.br/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
name
opcional string
Nome.
color
opcional integer
Cor. Os valores possíveis são: 1, 2, 3, 4, 5, 6.
Excluir

Ponto de extremidade da API:

DELETE 
https://yours.com.br/api/v1/spaces/{id}

Exemplo de solicitação: 

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