Pular para o conteúdo principal

Webservice de Ligações Externas

Âmbito​

A API do iLink disponibiliza um webservice dedicado para gerir e acompanhar, de forma autónoma, os pedidos de ligação EDI, como alternativa ao portal de ligações externas. Este webservice oferece as mesmas funcionalidades e comportamento do portal de ligações, podendo ser utilizado em conjunto com este.

Esta integração apenas está disponível a operadores EDI integrados com o ilink, e para ter acesso à mesma, deverá solicitar credenciais a apoio@ilink.pt ou pelo telefone 707 451 451. O acesso disponibilizado inclui uma chave de plataforma, que identifica o sistema/plataforma que acede ao webservice.

Notas técnicas​

  • O webservice segue a arquitetura REST
  • Os códigos de estado HTTP devolvidos respeitam o RFC 7231
  • Todos os dados enviados (incluindo anexos XML) devem ser codificados em UTF-8. Formatos como ANSI, UTF-8 BOM e ISO 8859-1 devem ser evitados para garantir compatibilidade com todos os sistemas recetores
  • As respostas (payloads) são devolvidas em formato JSON
  • Os servidores do ilink funcionam exclusivamente através de HTTPS, com versão TLS 1.2 (em caso de problemas de comunicação, consulte possíveis soluções para [Java][tls-java] e [C#][tls-csharp])
  • A especificação e o cliente de demonstração Swagger estão disponíveis aqui

Documentação Swagger​

O ilink utiliza uma especificação OpenAPI 3 num cliente Swagger, disponível aqui. Neste cliente web, pode efetuar chamadas de teste ao nosso API, analisar as respostas obtidas e verificar os dados a enviar para cada endpoint/método.

O cliente swagger disponibilizado acima deve acompanhar o seu processo de desenvolvimento. É também possível verificar como as chamadas ao API são construídas através do cURL (consulte o exemplo abaixo):

Exemplo de chamada cURL gerada pelo cliente Swagger

Autorização​

O token de plataforma deve ser incluído em todos os pedidos ao API no header abaixo:

  • Authorization: Bearer {ACCESS_TOKEN}

No cliente Swagger, o processo de autorização é efetuado inserindo o token de acesso após clicar no botão Authorize.

img info

Após esta operação, deve notar que todos os pedidos subsequentes ao API incluem o header Authorization:

img info

Caso o token de autorização esteja incorreto, será devolvida a seguinte resposta:

HTTP status: 401 Unauthorized

{
  "success": false,
  "errors": [
    {
      "code": "e069",
      "msg": "Autenticação inválida"
    }
  ]
}