;

Get Started

Veja mais informações sobre o padrão das nossas APIs e comece a integrar conosco!
No link a seguir apresentamos os padrões de retornos, os verbos HTTPs utilizados, as respostas esperadas e outros recursos interessantes para você iniciar o desenvolvimento.

Introdução

Bem vindo ao portal de APIs da Patrus Transportes.

Nossas APIs são construídas sobre o protocolo HTTP, são RESTFul e as requisições e respostas são em JSON no corpo da mensagem e usamos os principais verbos HTTP (GET, POST, PUT, DELETE).

Os recursos estão disponíveis em endereços de URL compostos pela versão da API, seguido do domínio de negócio (logística, erp, …), o subdomínio (operacional, …) e por fim o recurso (notas-fiscais),

Por exemplo:

/api/v1/logistica/operacional/notas-fiscais/{handle}
                            

O resultado é uma biblioteca de fácil consumo nas mais diversas linguagens de programação como C#, Java, Javascript, Ruby, Python, …

Autenticação

Todas as requisições aos nossos serviços requerem um usuário autorizado.

As autenticações são baseadas no protocolo OAuth2 no qual fornece um token de autenticação uso nas requisições.

Para consumo dos serviços, o token deve ser informado no header Authorization do HTTP.

Respostas e HATEOAS

Os recursos solicitados são encapsulados dentro de um objeto chamado Data.

Os serviços também disponibilizam HATEOAS (Hypermedia as the Engine of Application State) , ou seja proveem informações que permite navegar entre os serviços de forma dinâmica incluindo links junto às respostas.

Exemplo de respostas:

Request URL

http://localhost/api/v1/logistica/edi/arquivos-gerados/230

Response


 [{
    "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"
      }
    ]
  }]
                    

Códigos de Retorno

A API retorna os códigos de resposta HTTP.Estas são as informações mais relevantes:

Código Descrição
200 OK A chamada foi bem sucedida.
201 Created Um novo recurso foi adicionado
400 Bad Request A requisição é inválida, ou resultou em uma exceção de negócio
401 Unauthorized Token de acesso é inválido.
403 Forbidden O acesso está bloqueado ou o usuário está bloqueado.
404 Not Found O endereço acessado não existe ou o recurso procurado não existe
500 Internal Server Error Houve um erro interno do servidor ao processar a requisição.