Tipos de Integração
REST
O modelo REST (Representational State Transfer) representa uma “nova” possibilidade para a criação de web services, cujas principais diferenças em relação ao modelo tradicional (SOAP) estão na utilização semântica dos métodos HTTP (GET, POST, PUT e DELETE), na leveza dos pacotes de dados transmitidos na rede e na simplicidade, fazendo desnecessária a criação de camadas intermediárias (Ex.: Envelope SOAP) para encapsular os dados.
Figura 1 - REST
1
• Tipo: Escolha entre REST ou WSDL.
2
• Verbo: Pode ser GET, POST, PUT e DELETE.
3
• Padrão de Autenticação: Processo de verificação da identidade de um utilizador ou aplicação que aceda à API. A autenticação pode ser feita através de credenciais como nome de utilizador e senha, um certificado ou através de logon único (SSO) ou outros métodos.
Figura 2 - Integração
4
• Header: Uma parte da API de Memória do Dispositivo (Device Memory API), este cabeçalho representa uma quantidade aproximada de RAM que o cliente possui.
5
• URL: É uma interface de processamento de aplicações entre um servidor da Web e um navegador da Web.
6
• Body: O body de uma API é o corpo da mensagem que é enviada numa solicitação.
7
• Autenticação: Define o método que deve ser utilizado para conseguir acesso ao recurso.
8
• Resposta:
WSDL
• Parâmetros da Autenticação:
Figura 3 • Parâmetros da Autenticação
1
• Key: É um identificador exclusivo que autentica solicitações associadas a um projeto para fins de uso e faturamento.
2
• Value: O valor de uma API (Application Programming Interface) pode referir•se a vários conceitos, como:
• API Value Proposition: A ligação entre os fornecedores de APIs e os consumidores de APIs, tendo em conta a descoberta das necessidades e os benefícios oferecidos pelas APIs.
• Token de API: Uma cadeia de códigos que contém dados abrangentes que identificam um utilizador específico e o escopo de acesso concedido a esse utilizador.
• API de preços: O valor que seria cobrado por uma consulta, que reflete a tabela de preços vigente.
• Estrutura de dados gerais para APIs de lista: O valor deve ser de 0300 para uma API baseada em programa de serviços.
• Latência: O tempo que uma API do mercado de ações leva para enviar dados da fonte para a aplicação que fez a solicitação de dados.
Tipo de URl
Existem vários tipos de APIs, incluindo:
• APIs Web: Permitem a comunicação entre sistemas via internet, facilitando a integração de dados e a utilização das suas diferentes funcionalidades. As APIs Web normalmente usam o protocolo HTTP para mensagens de solicitação e fornecem uma definição da estrutura das mensagens de resposta.
• APIs RESTful: São APIs baseadas em recursos que são comumente utilizadas atualmente. Os clientes podem usar métodos HTTP comuns, como GET, POST, PUT e DELETE, para acessar recursos localizados no URL especificado no servidor.
• APIs SOAP: São consideradas o tipo mais seguro devido à conformidade com padrões.
• GraphQL: São tipicamente usadas para carregar dados de um servidor para um cliente.
• Webhook: Permitem que aplicações web recebam notificações automáticas em tempo real.
As APIs também podem ser classificadas de acordo com o seu acesso, como:
• Privada: São utilizadas internamente entre as aplicações de uma empresa, ou seja, de forma local.
• Parceira: São utilizadas entre parceiros de negócios ou para permitir a integração entre diferentes softwares.
• Pública: Podem ser utilizadas livremente e muitas vezes são disponibilizadas por empresas para que os desenvolvedores possam fazer a integração com outras aplicações.
Figura 4 • Tipo de URl:
1
• Tipo:
2
• Url: Digite a URL (Uniform Resource Locator)
• Contratos WSDL: Um contrato WSDL (Web Services Description Language) é um documento escrito em XML que descreve um serviço da web, funcionando como um contrato do serviço.
Figura 5 • Contratos WSDL
1
• Tipo:
2
• Header: Uma parte da API de Memória do Dispositivo (Device Memory API), este cabeçalho representa uma quantidade aproximada de RAM que o cliente possui.
3
• Tipo de valor:
4
• Tag:
5
• Tag Pai:
6
• Adicionar contrato: