Introdução

Tiago Assis
Tiago Assis
  • Atualizado

# Allowed HTTPs Requests

POST Criar um registro

PUT Atualizar um registro (parcial/total)

DELETE Deletar um registro

GET Buscar um ou mais registros

 

# Header Responses

200 — Sucesso

201 — Criado

204 — Sem conteúdo

401 — Sem autorização

403 — Acesso negado

404 — Not found

 

# Autenticação

Para realizar a consumação de qualquer recurso da API, é necessário que realize a autenticação, utilizando Bearer Authentication. Nela irá enviar um Header, com key: Authorization e value: Bearer {TOKEN}.

Clique aqui para conferir mais detalhes sobre como gerar o token da API.

 

curl -X GET \
https://api.dooca.store/products \
-H 'Authorization: Bearer {TOKEN}' \
-H 'Content-Type: application/json'

 

# Requisição POST

Na documentação primeiro é mostrado a URL para enviar a requisição POST, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado, se houver sucesso nessa requisição retorna um response com status 201. Segue o exemplo abaixo:

 

# Criar Grupo de Características

 

introducao01.png

 

Depois do status 201 também é retornado os dados criados.

 

{
"id": 1,
"feature_id": 1,
"external_id": null,
"name": "Generic Value",
"slug": "generic-value",
"image": null,
"position": 1,
"active": true,
"created_at": "2019-12-18 10:09:05",
"updated_at": "2019-12-18 10:09:05"
}

 

# Parâmetros

Sempre quando houver /: é necessário passar um parâmetro, como, por exemplo, alguma ID, na documentação estará em negrito o local onde se passa esse parâmetro e logo na linha abaixo estará especificando os parâmetros necessários.

 

# Consultar Cliente

introducao02.png

 

Como no exemplo abaixo em que pede para passar na rota o ID do cliente, por exemplo, se o cliente tiver ID 1, ficaria assim.

 

https://api.dooca.store/customers/:1

 

# Requisição GET

Na documentação primeiro é mostrado a URL para enviar a requisição GET, algumas rotas será necessário passar um parâmetro, já nos casos que não se passa parâmetro ele lista todos os dados, se houver sucesso na requisição ele retorna um response com status 200 , e irá trazer todas as informações como na imagem. Segue o exemplo abaixo:

 

# Listar Grupos de Características

introducao03.png

 

# Requisição PUT

Na documentação primeiro é mostrado a URL para enviar a requisição PUT, é informado qual o parâmetro necessário para enviar a requisição, é possível atualizar um registro parcial ou total, esses dados são enviados pelo body assim como no POST, se houver sucesso na requisição ele retorna um response com status 200 . Segue o exemplo abaixo.

 

introducao04.png

 

Depois do status 200 também é retornado os dados editados:

 

{
"id": 1,
"feature_id": 1,
"external_id": null,
"name": "Novo nome do Feature goup",
"slug": "novo-nome-do-feature-goup",
"image": null,
"position": 1,
"active": true,
"created_at": "2019-12-18 10:09:05",
"updated_at": "2020-01-14 08:57:37"
}

 

# Requisição DELETE

Na documentação primeiro é mostrado a URL para enviar a requisição DELETE, é informado qual o parâmetro necessário para enviar a requisição, não é enviado nenhum dado pelo body. Se o item for deletado com sucesso ele retorna um response com status 204. Segue um exemplo abaixo.

 

introducao05.png

 

# GET Default

Param Tipo Ex
limit int &limit=15
page int &page=1
sort string &sort=id ou &sort=-id
q string &q=buscar algo

 

page Indica a partir de qual recurso a consulta irá começar.

limit Indica a quantidade de recursos a serem retornados, indo de 20 a no máximo 100.

sort Indica por qual atributo a consulta deve ser ordenada.

q Indica que será feito uma busca contendo o valor passado.

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 1

Tem mais dúvidas? Envie uma solicitação

Comentários

0 comentário

Por favor, entre para comentar.