Categorias - Manual do usuário

Introdução

Na API do Procfy as categorias são representados por um objeto JSON com os seguintes atributos:

Atributos com o valor null serão retornados na resposta.

Atributo	Tipo	Descrição
id	integer	Identificador único da categoria
name	string	Nome da categoria
description	text	Descrição da categoria
transaction_type	string	Tipo de transação da categoria

Rotas

Método	Endpoint	Descrição
GET	/api/v1/categories	Visualizar várias categorias
GET	/api/v1/categories/:id	Visualizar uma categoria específica
POST	/api/v1/categories	Criar uma categoria
PUT	/api/v1/categories/:id	Editar uma categoria
DELETE	/api/v1/categories/:id	Excluir uma categoria

Visualizar várias categorias

O Procfy utiliza o padrão de paginação para retornar os resultados das requisições. Para mais informações sobre paginação, consulte a seção paginação. Para visualizar várias categorias, você deve fazer uma requisição para a API utilizando o método GET no endpoint correspondente ao objeto que deseja visualizar.

GET /api/v1/categories

Parâmetros aceitos

Parâmetro	Tipo	Descrição
page	integer	Número da página
items	integer	Quantidade de itens por página

Visualizar uma categoria específica

Para visualizar uma categoria específica, você deve fazer uma requisição para a API utilizando o método GET no endpoint correspondente ao objeto que deseja visualizar.

GET /api/v1/categories/:id

Criar uma categoria

Para criar um objeto, você deve fazer uma requisição para a API utilizando o método POST no endpoint correspondente ao objeto que deseja criar.

POST /api/v1/categories

Editar uma categoria

Para editar um objeto, você deve fazer uma requisição para a API utilizando o método PUT no endpoint correspondente ao objeto que deseja editar.

PUT /api/v1/categories/:id

Excluir uma categoria

Para excluir um objeto, você deve fazer uma requisição para a API utilizando o método DELETE no endpoint correspondente ao objeto que deseja excluir.

DELETE /api/v1/categories/:id

Visualizando várias categorias

A API utiliza o padrão de paginação para retornar os resultados das requisições. Para mais informações sobre paginação, consulte a seção paginação.

Exemplo de requisição para visualizar várias categorias

GET /api/v1/categories

Exemplo de resposta para visualizar várias categorias

{
  "page": {
    "page": 1,
    "items": 50,
    "pages": 1,
    "last": 1,
    "next": null,
    "prev": null,
    "count": 1,
    "from": 1,
    "to": 1
  },
  "data": [
    {
      "id": 57,
      "name": "Nome de empresa",
      "description": "Descrição"
    }
  ]
}

Criando uma categoria

Para criar um objeto, você deve fazer uma requisição para a API utilizando o método POST no endpoint correspondente ao objeto que deseja criar. A API vai retornar o objeto criado, caso não ocorra nenhum erro. O corpo da requisição deve conter um objeto com os atributos necessários para a criação do objeto. Os atributos são:

Atributo	Tipo	Obrigatório	Descrição
name	string	sim	Nome da categoria
description	text	não	Descrição da categoria
transaction_type	string	sim	Tipo de transação da categoria

Veja a lista de atributos necessários para a criação do objeto na tabela de atributos.

Exemplo de requisição para criar uma categoria

POST /api/v1/categories

Exemplo de corpo da requisição para criar uma categoria

{
  "name": "Nome",
  "description": "Descrição",
  "transaction_type": "revenue"
}

Exemplo de resposta para criar uma categoria

{
  "id": 57,
  "name": "Nome",
  "description": "Descrição",
  "transaction_type": "revenue"
}

Editando uma categoria

Para editar um objeto, você deve fazer uma requisição para a API utilizando o método PUT no endpoint correspondente ao objeto que deseja editar. A API vai retornar o objeto editado, caso não ocorra nenhum erro. O corpo da requisição deve conter um objeto com os atributos necessários para a edição do objeto. Veja a lista de atributos necessários para a edição do objeto na tabela de atributos.

Exemplo de requisição para editar uma categoria

PUT /api/v1/categories/:id

Exemplo de corpo da requisição para editar uma categoria

{
  "name": "Nome",
  "description": "Descrição alterada",
  "transaction_type": "revenue"
}

Exemplo de resposta para editar uma categoria

{
  "id": 57,
  "name": "Nome",
  "description": "Descrição alterada",
  "transaction_type": "revenue"
}

Erros

Erros que podem ocorrer durante a execução de uma categoria. Os erros de validação retornam um objeto com a chave error e description com a mensagem de erro. A mensagem de erro pode variar de acordo com o erro ocorrido.

Erros de validação

Os erros de validação são retornados quando os atributos obrigatórios não são informados ou quando os atributos informados não estão de acordo com as regras de validação.

Exemplo de resposta para erro de validação na criação ou edição de uma categoria (Objeto em branco)

{
  "error": "Registro inválido",
  "description": "A validação falhou: Nome não pode ficar em branco"
}

Exemplo de resposta para erro de enum na criação ou edição de uma categoria (transaction_type)

{
  "error": "Enum inválido",
  "description": "Tipo de transação inválido"
}

​Introdução

​Rotas

​Visualizar várias categorias

​Parâmetros aceitos

​Visualizar uma categoria específica

​Criar uma categoria

​Editar uma categoria

​Excluir uma categoria

​Visualizando várias categorias

​Criando uma categoria

​Editando uma categoria

​Erros

​Erros de validação

Introdução

Rotas

Visualizar várias categorias

Parâmetros aceitos

Visualizar uma categoria específica

Criar uma categoria

Editar uma categoria

Excluir uma categoria

Visualizando várias categorias

Criando uma categoria

Editando uma categoria

Erros

Erros de validação