APIs

Padronização das APIs

Numa integração entre sistemas temos sempre os Fornecedores, aqueles que fornecem suas APIs para a integração e os Consumidores, aqueles que consomem as API de integração.

Na imagem abaixo, Opentech, Buonny e BRK são exemplos de Fornecedores, e "Serviço 1" é um serviço que eles oferecem por meio de suas APIs. Usando uma analogia, observe na imagem que, sem padronização, os Consumidores precisam adaptar-se a cada tipo de tomada de Fornecedor. No entanto, com a padronização, o "Serviço 1" torna-se uma tomada única, independente do Fornecedor.

Para tornar essa padronização viável, os Fornecedores de API precisam se adequar ao padrão. Uma vez concluída essa etapa, o Fornecedor é homologado pela plataforma e fica disponível para integração com todos os Consumidores que já utilizam a API padrão da plataforma.

Vale destacar também que ao final do processo os Consumidores farão requisições nos Endpoints disponibilizados pela plataforma que será responsável por repassar para os Endpoints disponibilizados pelos Fornecedores.

A etapa de Adequação

Executado pelos Fornecedores de API, a etapa de Adequação consiste em disponibilizar novas APIs de acordo com a especificação e adotar o uso do Master Data Management (MDM)

Master Data Management (MDM)

Na estratégia da Plataforma nstech, o papel crucial do Master Data Management (MDM) se destaca na padronização dos valores possíveis dentro de um universo conhecido. Enquanto a especificação da API define o nome do campo padronizado, o MDM desempenha um papel central na uniformização dos dados disponíveis. Essa abordagem simplifica significativamente a interação entre consumidores e fornecedores, pois os consumidores não precisam estar cientes dos IDs específicos de cada fornecedor, mas sim dos IDs gerenciados pelo MDM. No entanto, é fundamental que tanto consumidores quanto fornecedores compreendam esses IDs para garantir o funcionamento harmonioso desse processo.

Para consumidores, é importante saber que você precisará enviar um dos IDs MDM, como o ID de um país, no JSON do corpo da solicitação ao fazer chamadas de API na plataforma. Isso significa que ao invocar as APIs da plataforma tal como SCAD ou SMON, você usará esses IDs MDM para especificar a entidade que deseja usar. Os campos das APIs que precisam de IDs MDM estão especificados na documentação.

Para fornecedores, uma vez que você recebe um ID MDM de um consumidor, é crucial entender o significado desse ID em seu próprio universo de dados. Por exemplo, se um ID MDM representa o "Brasil," você precisa mapear esse ID para os dados específicos em sua própria base de dados que correspondem ao Brasil, no seu caso poderia ser "Br", por exemplo. Isso garante que a comunicação entre consumidores e fornecedores seja precisa e eficaz.