;

EDI

A API permitirá que o cliente faça download dos arquivos EDI (Electronic Data Interchange)
Essa API é uma alternativa para quem hoje realiza o download através do nosso portal ou recebe o arquivo por e-mail, ftp entre outros.

Serviços


GET /api/v1/logistica/edi/arquivos-gerados

Retorna os arquivos gerados baseado em filtros

O serviço não retorna o arquivo (txt, xml, json) em si, apenas retorna a lista de arquivos disponíveis.
No fluxo padrão, o usuário deve buscar todos os arquivos "Gerados", para posterior download.

Exemplo de Response:
GET http://ws.patrus.com.br/api/v1/logistica/edi/arquivos-gerados?filtros.status=Gerado&filtros.tipo=Conemb

[
  {
    "Data": {
      "Handle": 230,
      "Tipo": {
        "Handle": 2,
        "Descricao": "OCORREN"
      },
      "DataGeracao": "2018-09-17T12:08:00",
      "UsuarioGeracao": "nome.usuario",
      "NomeArquivo": "CONEMB000000099.txt",
      "Status": {
        "Handle": 1,
        "Descricao": "Gerado"
      }
    },
    "Links": [
      {
        "rel": "download",
        "href": "http://ws.patrus.com.br/api/v1/logistica/edi/arquivos-gerados/230/download",
        "method": "POST"
      },
      {
        "rel": "recusar",
        "href": "http://ws.patrus.com.br/api/v1/logistica/edi/arquivos-gerados/230/recusar",
        "method": "POST"
      },
      {
        "rel": "self",
        "href": "http://ws.patrus.com.br/api/v1/logistica/edi/arquivos-gerados/230",
        "method": "GET"
      }
    ]
  }]
                    

Vejam que no retorno (HATEOAS) já consta o link onde é possível realizar o download (GET).



POST api/v1/logistica/edi/arquivos-gerados/{ID}/download

Esta API permitirá realizar o download "binário" de determinado arquivo.
Para tal, é necessário conhecer o ID (Handle) do documento que se deseja baixar.



POST api/v1/logistica/edi/arquivos-gerados/{ID}/recusar

Caso o arquivo que foi feito download apresente alguma inconsistência, você poderá recusar esse arquivo através desse serviço.



Fluxo

Logo, o fluxo esperado para uso dessa API é:

Buscar Arquivos Disponíveis
GET api/v1/logistica/edi/arquivos-gerados?filtros.status=Gerado&filtros.tipo=Conemb

Download de Arquivos Específicos
POST api/v1/logistica/edi/arquivos-gerados/2032412/download

Se o arquivo apresenta inconsistências, recuse-o
POST api/v1/logistica/edi/arquivos-gerados/2032412/recusar