Tecnologia - API's /SDK's

API - Aplication Programming Interface

Sigla para Application Programming Interface, é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma. APIs são largamente utilizadas no segmento de tecnologia e, em especial, no mercado financeiro e de pagamentos. A título de exemplo, o PIX funciona por meio de APIs, tal como o Open Banking. No caso da TAG, o padrão adotado para a comunicação da plataforma com seus usuários é integralmente API. Dessa forma, as integrações com clientes são realizadas por meio de APIs cuja especificação técnica está toda descrita na documentação de integração - Referência da API .

API methods

As APIs possibilitam que um usuário interaja com seus serviços a partir de ações ou requisições que se enquadram em alguma das categorias abaixo descritas (API methods). A documentação técnica das APIs descreve o método a ser utilizado em cada endpoint (terminal de conexão entre cada um dos serviços da API e seus usuários). A plataforma TAG possibilita as seguintes chamadas:

GET, que é responsável por realizar a requisição de um pedido de dados (exemplo: consulta de agenda de recebíveis);
POST,_ que é um tipo de requisição utilizado para criar ou adicionar informações (exemplo: registrar uma unidade de recebíveis); _e
PATCH, que é utilizado para atualização de uma parte dos dados (exemplo: alteração de averbação de contrato de troca de titularidade).

Assincronia

Os serviços disponibilizados pela API TAG funcionam a partir de uma lógica de requisições assíncronas. Isto é, quando um usuário comanda alguma ação, interagindo com um serviço assíncrono, a plataforma irá retornar um Status Code 202, que significa que a requisição foi aceita e está em processamento. Na sequência, o usuário recebe uma notificação informando que a requisição foi processada, não processada ou processada parcialmente. A lógica assíncrona permite que várias requisições sejam feitas de forma paralela pelo usuário, o que não ocorre com serviços síncronos. Nos serviços síncronos, o retorno das requisições de sucesso é um 200 (success) ou 201 (created), sem notificação de retorno (postback).