APIs internas e externas: um modelo de classificação para aumentar a eficácia e reduzir custos

Elemar Júnior

APIs são fundamentais em qualquer processo de transformação digital e, para que sejam adotadas e efetivas, precisam ser bem projetadas. Infelizmente, projetos infelizes acabam implicando em menos adesão e eficácia, desperdiçando recursos. No nosso entendimento, uma boa API começa pela definição de seu propósito.

De forma geral, em ambientes corporativos complexos, concordamos e recomendamos a categorização, já bem conhecida, de APIs em dois grupos distintos:

  1. APIs externas – que fornecessem acesso para dados e funcionalidades para aplicações usadas na “ponta”, além dos “muros” da organização atendendo clientes, fornecedores e parceiros. Geralmente, essas APIs podem serem consumidas por aplicações criadas por desenvolvedores que não trabalham na empresa.
  2. APIs internas –  expondo dados e funcionalidades dos sistemas de base – desenvolvidos internamente ou externamente, legados ou não – expondo, muitas vezes, detalhes de design. Essas APIs são projetadas para serem consumidas por código escrito “dentro de casa”, por desenvolvedores que trabalham “dentro” da empresa.

Gostamos dessa classificação por ela ajudar, inclusive, na organização dos times e na definição dos skills dos envolvidos.

Nesse modelo, as APIs externas, destinadas a interagir “na ponta”, precisam ser customer-centric. Ou seja, ajustadas para atender da forma mais pragmática possível as demandas das aplicações consumidoras. Enquanto isso, as APIs internas, que expõe dados e comportamentos dos sistemas de base (geralmente do backoffice), com frequência legadas, preservam o mesmo “espírito” desses sistemas.

 

 

Os processos de desenvolvimento das APIs externas guardam muitas semelhanças com práticas de UX. Entretanto, voltadas a facilitar a vida dos desenvolvedores e não de usuários finais. Nas APIs internas, é fundamental preservar o domínio de cada aplicação sendo exposta.

A orquestração da interação entre as APIs internas e externas é idealmente realizada em uma camada de mediação – agrupando requests, sequenciando interações, etc.

Essa categorização, quando aplicável, tem potencial para aumentar significativamente a eficácia das APIs, tanto internas quanto externas, favorecendo o aumento da adesão no consumo. Por serem bem determinadas, elas também colaboram para que projetos que não trafeguem dados desnecessários e resguardam os sistemas internos, resultando em mais segurança. Em função da especialização, há notória possibilidade de redução dos custos totais.

Em resumo

O problema
APIs são fundamentais em qualquer processo de transformação digital e, para que sejam adotadas e efetivas, precisam ser bem projetadas. Infelizmente, muitas organizações falham nisso e acabam comprometendo adesão e consumo.
O insight
As APIs poderiam ser classificadas como “internas” – expondo dados e funcionalidades dos sistemas de base para uso dos times de desenvolvimento da própria empresa – e “externas” – atendendo as especificidades das aplicações “na ponta”, além dos limites da organização. Eventualmente, deve-se construir uma camada de “mediação” entre APIs dessas categorias para orquestrar a relação.
Os benefícios
APIs internas e externas possuem métodos de desenvolvimento distintos. A classificação das APIs ajuda a “clarificar” métodos de trabalho apropriados, aumentando a efetividade e reduzindo custos potenciais.

Compartilhe este insight:

Comentários

Participe deixando seu comentário sobre este artigo a seguir:

Subscribe
Notify of
guest
2 Comentários
Oldest
Newest Most Voted
Inline Feedbacks
View all comments
Thiago Estevão Mathias Alves de lima
Thiago Estevão Mathias Alves de lima
2 anos atrás

Entendi que essa classificação seja é bom e faz sentido para uma empresa. No entanto acredito que os custos sejam maiores e não menores visto que você terá desenvolvimento maior para expor eventualmente a mesma coisa para “canal” diferente e também terá os custos de manter esses dois ou mais APIs equalizadas frente a alterações. Não podemos esquecer os custos de infra para eles . Por isso entendo que a classificação de interna e externa seja válida e funcione bem, porém isso pode ser derivado os APIs por canal, onde acredito que possa não ser ser tão bom até mesmo para governar. O que acham sobre isso?

Renan Aragão
Renan Aragão
2 anos atrás

Acredito que é uma complexidade acidental classificar as API em externas e internas em uma situação onde os dados expostos são iguais. Eu faria todas as API pensando no consumo externo, dessa forma atenderia todos os clientes internos e externos iguais.

AUTOR

Elemar Júnior
Fundador e CEO da EximiaCo atua como tech trusted advisor ajudando empresas e profissionais a gerar mais resultados através da tecnologia.

NOVOS HORIZONTES PARA O SEU NEGÓCIO

Nosso time está preparado para superar junto com você grandes desafios tecnológicos.

Entre em contato e vamos juntos utilizar a tecnologia do jeito certo para gerar mais resultados.

Insights EximiaCo

Confira os conteúdos de negócios e tecnologia desenvolvidos pelos nossos consultores:

Arquitetura de Dados

Insights de um DBA na análise de um plano de execução

Especialista em performance de Bancos de Dados de larga escala
Arquitetura de Software

Estratégias para modernização do legado

Desenvolvedor .NET/NodeJs e especialista em Kafka com experiência em startups e grandes empresas
Infraestrutura e Nuvem

Migração para a nuvem, mais do que mudança tecnológica, implica em mudança da cultura organizacional

Engenheiro de nuvem, arquiteto de software e especialista em Containers e Devops

Acesse nossos canais

Simplificamos, potencializamos e aceleramos resultados usando a tecnologia do jeito certo

EximiaCo 2022 – Todos os direitos reservados

2
0
Queremos saber a sua opinião, deixe seu comentáriox
()
x

APIs internas e externas: um modelo de classificação para aumentar a eficácia e reduzir custos

Para se candidatar nesta turma aberta, preencha o formulário a seguir:

Condição especial de pré-venda: R$ 14.000,00 - contratando a mentoria até até 31/01/2023 e R$ 15.000,00 - contratando a mentoria a partir de 01/02/2023, em até 12x com taxas.

Tenho interesse nessa capacitação

Para solicitar mais informações sobre essa capacitação para a sua empresa, preencha o formulário a seguir:

Tenho interesse em conversar

Se você está querendo gerar resultados através da tecnologia, preencha este formulário que um de nossos consultores entrará em contato com você:

O seu insight foi excluído com sucesso!

O seu insight foi excluído e não está mais disponível.

O seu insight foi salvo com sucesso!

Ele está na fila de espera, aguardando ser revisado para ter sua publicação programada.

Tenho interesse em conversar

Se você está querendo gerar resultados através da tecnologia, preencha este formulário que um de nossos consultores entrará em contato com você:

Tenho interesse nessa solução

Se você está procurando este tipo de solução para o seu negócio, preencha este formulário que um de nossos consultores entrará em contato com você:

Tenho interesse neste serviço

Se você está procurando este tipo de solução para o seu negócio, preencha este formulário que um de nossos consultores entrará em contato com você:

× Precisa de ajuda?