Termos e Jargões Mais Comuns no Mundo das APIs
Olá TNs, bora falar de APIs? Na publicação de hoje, vamos falar sobre os termos mais utilizados no mundo da API!! 😲
Vamos explorar como estes conceitos estão relacionados e ficar com um pezinho mais perto do ecossistema da integração, pois afinal, precisamos nos integrar cada vez mais! 😄
DISCLAIMER 1: Criei esta publicação com o objetivo de ser fonte de consulta para conceitos simples e de material de referência para meus futuros alunos/professores.
DISCLAIMER 2: Esta publicação contém muito da minha experiência na área de integração, tem partes de consultas feitas ao ChatGPT e tem referências externas também.
DISCLAIMER 3: Se algum termo não fizer sentido pra você, deixe nos comentários que atualizo a publicação com sua indicação!
API
- Application Programming Interface.
- Permite a comunicação entre diferentes sistemas ou plataformas.
- É um conjunto de protocolos, rotinas e ferramentas para construir software e permitir que diferentes sistemas se comuniquem e troquem informações.
API Design-first
- Abordagem para o desenvolvimento de APIs que começa com a criação de uma especificação da API antes de começar a implementá-la. Isso permite que os desenvolvedores tenham uma visão clara do que a API deve fazer e como ela deve ser usada antes de começar a codificar.
API Design
- API Design é o processo de projetar uma API, incluindo sua arquitetura, funcionalidades, formato de dados, usabilidade e documentação.
- O objetivo da API Design é criar uma interface que seja fácil de usar e entender para os desenvolvedores, enquanto também atende às necessidades do negócio e é escalável e segura.
API Versioning
- Processo de atribuir versões diferentes a uma API ao longo do tempo, para permitir que ela evolua sem afetar os usuários existentes.
API Specification
- API Specification é um documento que descreve as funcionalidades e a interface de uma API.
- A especificação da API pode incluir detalhes técnicos como a arquitetura da API, os formatos de dados suportados, os métodos de autenticação e autorização, e os endpoints disponíveis.
- Também pode incluir informações sobre a experiência do usuário, como exemplos de código e documentação para ajudar os desenvolvedores a entender como usar a API.
- É o produto resultado do API Design.
API Documentation
- Documentação detalhada ou material de referência provisionada pelo criador de uma API.
- Serve para explicar como utilizar a API e demonstrar seus vários endpoints, parâmetros e limitações.
API Provider
- O API Provider é a pessoa ou empresa que cria e disponibiliza uma API para uso por outros aplicativos.
- O API Provider é responsável por projetar, implementar, documentar e hospedar a API, bem como gerenciar sua disponibilidade e performance.
- O API Provider pode ser um desenvolvedor individual, uma empresa de tecnologia ou qualquer outra organização que queira expor suas funcionalidades através de uma API para ser consumida por outros aplicativos.
API Portal
- Plataforma que fornece acesso a uma ou mais APIs, geralmente incluindo documentação, exemplos de código e outras informações úteis para os desenvolvedores.
- É uma ponte entre o API Provider e o API Consumer.
- São maneiras de tornar as APIs públicas e oferecerem conteúdos para educar desenvolvedores sobre as APIs, seu uso e como ser base para outras APIs.
- No API Portal é provisionado informação sobre as APIs em cada estágio do API Lifecycle.
API Marketplace
- Plataforma online que fornece acesso a uma ampla variedade de APIs diferentes, geralmente agrupadas por categoria ou propósito.
API Implementation
- É o processo de criar e implementar uma API.
- Após a criação da API, é preciso implementar o código que faz a API funcionar e hospedar a API em um servidor para que ela esteja disponível para ser usada por outros aplicativos.
API Request
- É a chamada para o servidor ou base de dados através de uma url e endpoint.
API Response
- É a resposta fornecida por uma API quando ela recebe uma API Request.
- Na resposta pode conter dados, mensagens de erro ou outras informações, dependendo da solicitação feita e da API Implementation.
API Invocation
- É a ação de enviar uma requisição para a API.
API Call
- É o processo de enviar uma requisição para a API.
API Consumer
- É a pessoa ou aplicação que utiliza uma API para acessar os dados ou os recursos fornecidos por ela.
- O consumidor da API envia API Requests para a API através de uma API Call, e recebe uma API Response com os dados ou informações solicitadas.
API Keys
- É um identificador único que habilita outros softwares a autenticarem um usuário, desenvolvedor ou software através de uma API Call para uma API que assegura que esta pessoa ou software é realmente quem ela diz ser.
- Este identificador único autentica a API ao invés de um usuário e oferece um certo nível de segurança para as API Calls.
API Endpoint
- É o fim de um canal de comunicação.
- Quando API interage com outros sistemas, cada ponto de interação é considerado um endpoint.
- Pode ser um servidor, um serviço, ou uma base de dados onde um recurso vive.
API Economy
- É o termo utilizado para descrever a troca de valor entre um usuário e uma organização.
- É o conjunto de empresas, indivíduos e organizações que utilizam APIs para gerar valor e inovar em seus negócios.
- Isso pode incluir a criação e a venda de APIs, ou a utilização de APIs de terceiros para integrar novos recursos ou funcionalidades em produtos ou serviços existentes.
API Integration
- Conecta duas ou mais aplicações para trocarem dados entre eles e se conectar ao mundo externo.
API Mashup
- Aplicação que combina dados ou funcionalidades de duas ou mais APIs diferentes para criar algo novo e útil.
API Broker
- Servidor que atua como intermediário entre um cliente e várias APIs diferentes, permitindo que o cliente acesse todas elas de uma única interface.
API Management
- Também conhecido como APIM.
- Software que ajuda a gerenciar e monitorar o uso de uma ou mais APIs, incluindo coisas como autenticação, rate limiting, métricas de uso e segurança.
API Monetization
- É um processo pelo qual um negócio pode gerar receita de suas APIs.
- Desde que APIs habilitam usuários a acessarem e integrarem dados de diferentes origens, eles podem ser utilizados por diferentes desenvolvedores para integrar serviços relevantes dentro de seus produtos, serviços digitais, ou aplicações, que poderia, se tornar a fonte de receita para ambos os serviços públicos e privados e para aplicações.
- Processo de gerar receita de uma ou mais APIs, geralmente através de modelos de negócios como assinaturas, cobranças por uso ou vendas de dados.
API Gatekeeper
- É um sistema que controla o acesso a uma API. Ele verifica se as API Requests são autorizadas e, se sim, permite que elas sejam processadas pela API Implementation.
- Se uma API Request não for autorizada, o API Gatekeeper pode negar acesso à API ou fornecer uma API Response alternativa.
- O API Gatekeeper pode ser usado para proteger a API de acesso não autorizado e para garantir que apenas aplicativos autorizados possam acessar os recursos da API.
- Ele também pode ser usado para monitorar o uso da API e para controlar o tráfego de solicitações de API, por exemplo, limitando o número de solicitações que podem ser feitas em um determinado período de tempo.
API Proxy
- API Proxy é um intermediário entre uma API Implementation e os aplicativos que consomem a API.
- Ele recebe as API Requests dos aplicativos, as encaminha para a API Implementation e depois retorna as API Response para os aplicativos.
- O API Proxy pode ser usado para adicionar funcionalidades a uma API Implementation, como autenticação, cache, rate-limiting e gerenciamento de erros, sem precisar alterar o código da API.
- Ele também pode ser usado para ocultar os detalhes de implementação da API e para proteger a API de acesso não autorizado.
API Client
- Um API Client é a pessoa ou programa que usa a API.
- O cliente faz requisições à API para recuperar alguma informação ou alterar algo dentro da aplicação.
- Seu navegador da web é um cliente — ele interage com APIs de diferentes sites para obter o conteúdo da página deles.
API Rate Limiting
- Processo de limitar o número de solicitações que uma API pode receber de um determinado cliente em um período de tempo específico. Isso é geralmente implementado para proteger uma API de sobrecarga e garantir que ela continue disponível para todos os usuários.
API Throttling
- Processo semelhante ao Rate Limiting, mas que se aplica ao número de solicitações que uma API pode processar em um determinado período de tempo.
API Gateway
- É uma ferramenta de gerenciamento de API que serve como um intermediário entre o cliente e um conjunto de serviços do backend.
- Atuam como Gatekeepers e Proxies que moderam todas suas API Calls, agregam os dados que você precisa, e retorna o resultado correto.
- Serviço que atua como intermediário entre um cliente e uma API, geralmente fornecendo funcionalidades adicionais como autenticação, API Identification, API Rate Limiting, Métricas de Uso e segurança.
API Security
- É um termo guarda-chuva que define um conjunto de práticas que visam prevenis ataques maliciosos, mal uso, abusos e exploração de vulnerabilidades das APIs.
- Está incluído neste pacote o Basic Authentication, Autorização, Tokens, Multi-Factor Authentication, e outras medidas de segurança avançadas.
- As APIs são amplamente utilizadas para permitir que diferentes sistemas e aplicações se integrem e compartilhem dados, o que as tornam um alvo atraente para hackers.
API Sandbox
- Ambiente de testes que permite que os desenvolvedores experimentem uma API sem afetar os dados ou os sistemas reais.
API Console
- Ferramenta que fornece acesso a uma API e permite que os desenvolvedores experimentem enviando solicitações e examinando as respostas.
API Notebook
- Ferramenta que permite aos desenvolvedores testar e experimentar APIs através de uma interface baseada em navegador.
- Ele fornece uma plataforma para escrever, executar e compartilhar código de exemplo que faz solicitações de API e exibe as respostas.
- É útil para desenvolvedores que querem aprender a usar uma API ou para aqueles que querem testar e depurar suas integrações com uma API.
API Stub
- Programa que simula uma API para fins de teste ou demonstração.
API Mock
- Programa que simula uma API de maneira mais avançada, incluindo a capacidade de retornar respostas personalizadas para diferentes solicitações.
API Wrapper
- É o programa que encapsula uma API e fornece uma interface mais fácil de usar para os desenvolvedores.
API Facade
- Este programa fornece uma interface simplificada para uma API complexa, ocultando os detalhes de implementação subjacentes.
API Packing
- Processo de incluir várias APIs em uma única aplicação ou pacote.
- Isso pode ajudar a simplificar a distribuição e o gerenciamento das APIs e a trazer economia de recursos.
API Admin
- É a pessoa responsável por gerenciar uma ou mais APIs e ter tarefas como atualizações, manutenção e suporte aos usuários.
API Analyst
- Pessoa responsável por analisar os dados de uso e as métricas de uma API para entender como ela está sendo utilizada e identificar oportunidades de melhoria.
API Developer
- Pessoa responsável por desenvolver uma ou mais APIs, incluindo tarefas como codificação, testes e depuração.
API Governance
- Processo de gerenciamento e controle de uma ou mais APIs, incluindo tarefas como definição de políticas, padrões e procedimentos.
API Management
- É o processo de gerenciar APIs para permitir que elas sejam facilmente usadas por desenvolvedores de aplicativos.
- Isso inclui a criação e documentação de APIs, o gerenciamento de acesso e o uso e a monitoração do desempenho da API.
API Development
- Processo de criação de uma ou mais APIs, incluindo tarefas como projeto, codificação, testes e depuração.
API Lifecycle
- É uma abordagem para API Management e API Development que visa prover uma visão holística - do fluxo como um todo - de como lidar com as APIs ao redor de seus diferentes estágios de vida, desde a concepção até a descontinuação.
- Pode ter tarefas como planejamento, design, implementação, teste, publicação, monitoramento e manutenção.
- Normalmente é dividido em 3 estágios: Criação, Controle e Consumo.
- Na Mulesoft a divisão é: Design, Implementation, Management.
API Layer
- É um proxy que unifica todos os serviços oferecidos usando uma interface gráfica para prover mais interatividade ao usuário.
- Elas são agnósticas aos tipos de linguagens e ajudam a descrever os serviços e os tipos de dados utilizados para trocarem informações.
API-Led Conectivity
- API-Led Connectivity é um método para construir integrações entre sistemas usando APIs como o principal meio de conexão. Este método envolve a criação de três tipos de APIs: experiência, processo e sistema.
- As APIs de experiência são destinadas ao usuário final e são usadas para criar interface com o usuário.
- As APIs de processo são usadas para automatizar processos de negócios.
- As APIs de sistema são usadas para integrar sistemas e proteger o backend.
- O objetivo da API-Led Connectivity é fornecer uma conexão mais rápida e mais flexível entre sistemas e aplicativos.
API Testing
- Processo para verificar se uma API está funcionando corretamente e atendendo aos requisitos especificados.
API Execution
- API Execution é o processo de fazer uma API Call e obter uma API Response.
- Isso envolve enviar uma solicitação de API para o servidor da API, esperar a resposta e processar a resposta recebida.
API Trigger
- É a porta de entrada, por onde a API Implementation inicia sua execução. Pode ser por meio de requisição, por meio de agendamento, eventos, etc.
API REST
- Uma API que segue o padrão arquitetural REST (Representational State Transfer). Esse padrão define como a API deve ser projetada e como os dados devem ser trocados entre os clientes e os servidores.
API GraphQL
- API que utiliza a linguagem de consulta GraphQL para permitir que os clientes solicitem exatamente os dados de que precisam e nenhum mais.
API SOAP
- É uma API que utiliza o protocolo SOAP (Simple Object Access Protocol) para se comunicar com outros sistemas.
API Reversa
- Também é muito conhecida como Webhook, HTTP Push API, HTTP Callback ou Web Callback.
- Uma função de uma API que permite que ela envie notificações para outros sistemas quando certos eventos ocorrem. Por exemplo, uma API de mídia social pode usar webhooks para notificar outros sistemas sempre que um novo post é publicado.