README ConnectTEF | Índice da Seção | Anterior | Próximo —
Caminho: Início / Integrações / Integracao via API Rest
A API REST é o principal modelo de integração disponibilizado pelo ConnectTEF para aplicações modernas.
Através dela, qualquer sistema capaz de realizar requisições HTTP pode controlar pagamentos, consultar transações, obter informações dos dispositivos SmartPOS e utilizar os serviços disponibilizados pela plataforma.
Este modelo foi desenvolvido para oferecer uma integração simples, desacoplada e independente da linguagem de programação utilizada pelo ERP ou PDV.
Apresentar o modelo de integração via API REST, suas características, vantagens e cenários recomendados de utilização.
A aplicação comercial comunica-se diretamente com o ConnectTEF através de chamadas HTTP utilizando APIs REST.
Toda a complexidade de comunicação com fabricantes, adquirentes e dispositivos SmartPOS é abstraída pela plataforma.
ERP / PDV
│
│ REST API
▼
ConnectTEF
│
├── SmartPOS
├── Adquirentes
├── Gateways
└── Serviços da Plataforma
O ERP permanece desacoplado dos fabricantes de equipamentos e dos protocolos proprietários utilizados pelo mercado.
Por utilizar REST, praticamente qualquer linguagem pode integrar-se ao ConnectTEF.
Exemplos:
Qualquer tecnologia capaz de realizar chamadas HTTP pode consumir a API.
A integração via REST é indicada para:
A comunicação ocorre através de protocolos amplamente utilizados pelo mercado.
Não há necessidade de bibliotecas proprietárias para iniciar a integração.
O ERP pode ser desenvolvido em qualquer linguagem de programação.
A tecnologia utilizada pela aplicação não interfere na comunicação com o ConnectTEF.
Toda a comunicação com fabricantes e dispositivos permanece centralizada no ConnectTEF.
Isso reduz significativamente o impacto de futuras evoluções da plataforma.
Novos recursos podem ser disponibilizados sem necessidade de alterar a arquitetura da aplicação integrada.
A integração permanece válida mesmo com a evolução da plataforma.
A API REST permite acesso aos principais serviços do ConnectTEF, incluindo:
Os recursos disponíveis evoluem continuamente conforme novas funcionalidades são incorporadas ao ConnectTEF.
A comunicação pode utilizar:
Os mecanismos de autenticação e autorização são documentados em detalhes na seção específica de segurança.
A API REST é versionada para garantir compatibilidade entre diferentes versões da plataforma.
Isso permite evolução contínua sem comprometer integrações já existentes.
A API REST deve ser considerada o modelo preferencial para novos projetos.
Ela oferece o melhor equilíbrio entre:
Embora a API REST seja a recomendação principal, outros modelos podem ser mais adequados em situações específicas.
Exemplos:
Cada tecnologia possui um documento específico detalhando seus cenários de utilização.
Nos próximos capítulos serão apresentados os demais modelos de integração suportados pelo ConnectTEF, permitindo que cada empresa escolha a tecnologia mais adequada para sua arquitetura.