Anexos de transações - Manual do usuário

Introdução

Na API do Procfy os anexos são representadas 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 transação
filename	string	Nome do arquivo
byte_size	integer	Tamanho do arquivo
content_type	string	Tipo do arquivo
created_at	date	Data de criação
url	url	Url do anexo para o envio do mesmo

Rotas

Método	Endpoint	Descrição
GET	/api/v1/transactions/:id/attachments	Visualizar todos os anexos da transação
GET	/api/v1/transactions/:id/attachments/:id	Visualizar um anexo específico da transação
POST	/api/v1/transactions/:id/attachments	Criar anexo em uma transação
DELETE	/api/v1/transactions/:id/attachments/:id	Excluir um anexo de uma transação
GET	/api/v1/transactions/:id/attachments/:id/download	Baixar o arquivo

Visualizar todos os anexos da transação

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ários anexos, 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/transactions/:id/attachments

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 anexo específico da transação

Para visualizar um anexo específico, 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/transactions/:id/attachments/:id

Criar anexo em uma transação

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/transactions/:id/attachments

Excluir uma anexo da transação

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/transactions/:id/attachments/:id

Baixar o arquivo

Para fazer download de um arquivo, você deve fazer uma requisição para a API utilizando o método GET no endpoint correspondente ao arquivo que deseja fazer o download.

GET /api/v1/transactions/:id/attachments/:id/download

Visualizar todos os anexos da transação

A API disponibiliza algumas opções de filtro para a listagem de anexos. Os parâmetros aceitos são:

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

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 todos os anexos da transação

GET /api/v1/transactions/:id/attachments

Exemplo de resposta para visualizar todos os anexos da transação

{
  "page": {
    "page": 1,
    "items": 50,
    "pages": 1,
    "last": 1,
    "next": null,
    "prev": null,
    "count": 2,
    "from": 1,
    "to": 2
  },
  "data": [
    {
      "id": 179,
      "filename": "2022.xlsx",
      "byte_size": 242071,
      "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "created_at": "2024-11-04T14:17:15.799-03:00",
      "url": "https://api.procfy.io/v1/transactions/14923/attachments/179/download"
    },
    {
      "id": 183,
      "filename": "my",
      "byte_size": 39898,
      "content_type": "image/jpeg",
      "created_at": "2024-11-06T14:22:39.683-03:00",
      "url": "https://api.procfy.io/api/v1/transactions/14923/attachments/183/download"
    }
  ]
}

Visualizar um anexo específico da transação

Para consultar um objeto, você deve fazer uma requisição para a API utilizando o método GET no endpoint correspondente ao objeto que deseja consultar. A API vai retornar o objeto consultado, caso não ocorra nenhum erro.

Exemplo de requisição para visualizar um anexo específico da transação

GET /api/v1/transactions/:id/attachments/:id

Exemplo de resposta para visualizar um anexo específico da transação

{
  "id": 691042,
  "filename": "Backup-Procfy-06-11-2024 14-55-05.xlsx",
  "byte_size": 33164,
  "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "created_at": "2024-11-06T15:34:24.871-03:00",
  "url": "https://api.procfy.io/api/v1/transactions/45144183/attachments/691042/download"
}

Criando anexo em uma transação

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
filename	file	sim	Arquivo que deseja anexar

Exemplo de requisição para criar anexo em uma transação

POST /api/v1/transactions/:id/attachments

Exemplo de resposta para criar uma transação

{
  "id": 186,
  "filename": "my",
  "byte_size": 39898,
  "content_type": "image/jpeg",
  "created_at": "2024-11-06T16:09:10.038-03:00",
  "url": "https://api.procfy.io/api/v1/transactions/14923/attachments/186/download"
}

Excluindo um anexo de uma transação

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. A API vai retornar o objeto excluido, caso não ocorra nenhum erro.

Exemplo de requisição para excluir um anexo de uma transação

DELETE /api/v1/transactions/:id/attachments/:id

Exemplo de resposta para excluir um anexo de uma transação

{
  "id": 184,
  "filename": "my",
  "byte_size": 39898,
  "content_type": "image/jpeg",
  "created_at": "2024-11-06T16:02:45.841-03:00",
  "url": "https://api.procfy.io/api/v1/transactions/14923/attachments/183/download"
}

Download de arquivo

Para fazer download de um arquivo, você deve fazer uma requisição para a API utilizando o método GET no endpoint correspondente ao arquivo que deseja fazer download. A API vai retornar o arquivo criado, caso não ocorra nenhum erro.

Exemplo de requisição para download de arquivo

GET /api/v1/transactions/:id/attachments/:id/download

​Introdução

​Rotas

​Visualizar todos os anexos da transação

​Parâmetros aceitos

​Visualizar uma anexo específico da transação

​Criar anexo em uma transação

​Excluir uma anexo da transação

​Baixar o arquivo

​Visualizar todos os anexos da transação

​Visualizar um anexo específico da transação

​Criando anexo em uma transação

​Excluindo um anexo de uma transação

​Download de arquivo

Introdução

Rotas

Visualizar todos os anexos da transação

Parâmetros aceitos

Visualizar uma anexo específico da transação

Criar anexo em uma transação

Excluir uma anexo da transação

Baixar o arquivo

Visualizar todos os anexos da transação

Visualizar um anexo específico da transação

Criando anexo em uma transação

Excluindo um anexo de uma transação

Download de arquivo