Back to top

API da Discografia do Tião Carreiro & Pardinho - Supliu Tecnologia

Apresentação

Olá! Seja muito bem vindo a documentação da API da discografia do Tião Carreiro & Pardinho.

O objetivo desse projeto é servir uma API para os candidatos da vaga Programador Frontend consigam desenvolver o teste proposto na 2ª etapa do processo seletivo na Supliu Tecnologia.

Qualquer dúvida, entre em contato no email: contato@supliu.com.br

–

Autenticação

Utilizando a API

Para consumir essa API, envie no cabeçalho das requisições o atributo Authorization com o token informado nas instruções do teste enviadas por email.

Authorization: <token>

Álbuns

Listar álbuns

Retorna lista de albuns cadastrados

Listar
GET/album

Exemplo cURL:

curl 'https://tiao.supliu.com.br/api/album?keyword=Minas&limit=10&page=1' \
  -H 'Content-type: application/json' \
  -H 'Authorization: <token>'

Example URI

GET https://tiao.supliu.com.br/api/album
URI Parameters
HideShow
keyword
string (required) 

Pesquisar por palavra chave

Criar álbum

Cria um novo álbum e retorna o identificador

Criar
POST/album

Exemplo cURL:

curl -X POST 'https://tiao.supliu.com.br/api/album' \
  -H 'Content-type: application/json' \
  -H 'Authorization: <token>' \
  -d '{"name": "Rei do Gado", "year":"1961"}'

Example URI

POST https://tiao.supliu.com.br/api/album
URI Parameters
HideShow
name
string (required) 

CPF ou CNPJ do devedor

year
string (required) 

Nome do devedor

Excluir álbum

Exclui um álbum

Excluir
DELETE/album/{id}

Exemplo cURL:

curl -X DELETE 'https://tiao.supliu.com.br/api/album/{id}' \
  -H 'Content-type: application/json' \
  -H 'Authorization: <token>'

Example URI

DELETE https://tiao.supliu.com.br/api/album/id
URI Parameters
HideShow
id
integer (required) 

ID do devedor.

Faixa

Adicionar faixa

Adiciona uma nova faixa em um álbum

Criar
POST/track

Exemplo cURL:

curl -X POST 'https://tiao.supliu.com.br/api/track' \
  -H 'Content-type: application/json' \
  -H 'Authorization: <token>' \
  -d '{"album_id": 1, "number": 1, "title":"Alma de Boêmio", "duration":195 }'

Example URI

POST https://tiao.supliu.com.br/api/track
URI Parameters
HideShow
album_id
integer (required) 

Identificador do álbum

number
integer (required) 

Número da faixa

title
string (required) 

Nome da música

duration
integer (required) 

Tempo de duração em segundos

Excluir faixa

Exclui uma faixa

Excluir
DELETE/track/{id}

Exemplo cURL:

curl -X DELETE 'https://tiao.supliu.com.br/api/track/{id}' \
  -H 'Content-type: application/json' \
  -H 'Authorization: <token>'

Example URI

DELETE https://tiao.supliu.com.br/api/track/id
URI Parameters
HideShow
id
integer (required) 

ID da faixa.

Generated by aglio on 10 May 2022