Espaços

Observações
Nível avançado
A chave da API deve ser enviada como um token Bearer no cabeçalho Authorization da requisição. Obtenha sua chave da API.
Listar

Endpoint da API:

GET 
http://zjogo.link/api/v1/spaces

Exemplo de requisição: 

curl --location --request GET 'http://zjogo.link/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
O termo da busca.
search_by
opcional string
Buscar por. Os valores possíveis são: name para Nome. Padrão: name.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, name para Nome. Padrão: id.
sort
opcional string
Ordenar. Os valores possíveis são: desc para Decrescente, asc para Crescente. Padrão: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. Padrão: 10.
Exibir

Endpoint da API:

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

Exemplo de requisição: 

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

Endpoint da API:

POST 
http://zjogo.link/api/v1/spaces

Exemplo de requisição: 

curl --location --request POST 'http://zjogo.link/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
O nome do espaço.
color
opcional integer
O código da cor. Os valores possíveis são: 1, 2, 3, 4, 5, 6. Padrão: 1.
Atualizar

Endpoint da API:

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

Exemplo de requisição: 

curl --location --request PUT 'http://zjogo.link/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
O nome do espaço.
color
opcional integer
O código da cor. Os valores possíveis são: 1, 2, 3, 4, 5, 6.
Excluir

Endpoint da API:

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

Exemplo de requisição: 

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