Terminologia básica

Uma interface de programação de aplicativos é uma interface que facilita que um aplicativo consuma recursos ou dados de outro aplicativo.

Ao definir pontos de entrada estáveis e simplificados para a lógica e os dados do aplicativo, as APIs permitem que os desenvolvedores acessem e reutilizem facilmente a lógica do aplicativo criada por outros desenvolvedores. No caso de Web APIs, essa lógica e dados são expostos na rede. Como os aplicativos que consomem APIs são sensíveis às alterações, as APIs também implicam um contrato. O contrato fornece algum nível de garantia de que, com o tempo, a API mudará de maneira previsível.

A Apigee fornece muitas informações sobre APIs e práticas recomendadas para desenvolver e consumir essas APIs. Para começar, consulte o webcast API Design ou faça o download do e-book sem custo financeiro Web API Design: The Missing Link Best Practices for crafting Interfaces que os desenvolvedores adoram.

Uma fachada no Edge para uma ou mais APIs, serviços HTTP genéricos ou aplicativos (como Node.js).

Um proxy de API é implementado como um conjunto de arquivos de configuração, políticas e códigos que dependem de um conjunto de recursos fornecidos pelo Apigee Edge. Os proxies da API podem ser gerados e configurados usando a IU de gerenciamento do Apigee Edge ou podem ser implementados localmente em um editor de texto ou ambiente de desenvolvimento integrado.

A fachada fornecida por um proxy de API separa a API voltada para o desenvolvedor dos serviços de backend, protegendo os desenvolvedores de alterações de código e permitindo a inovação na borda sem afetar suas equipes de desenvolvimento interno. Conforme as equipes de desenvolvimento fazem alterações de back-end, os desenvolvedores continuam chamando a mesma interface sem interrupções. A Apigee permite expor várias interfaces para a mesma API, liberando você para personalizar a assinatura de uma API para atender às necessidades de vários setores de desenvolvedores simultaneamente.

APIs definidas por endereços de rede e URIs. Uma API é composta por um caminho base e um conjunto de recursos de API. Cada proxy de API define um caminho base e, opcionalmente, vários caminhos de recursos da API. Pense em uma API simplesmente como um conjunto de URIs, todos compartilhando um caminho base comum.

Para facilitar o gerenciamento das APIs, a Apigee aumenta esses URIs brutos com nomes de exibição e descrições. O Edge permite anexar políticas e códigos a URIs, permitindo controle e gerenciamento detalhados do comportamento das suas APIs.

Uma coleção de recursos de API (URIs) combinada com uma cota ou um plano de serviço, que é publicado para os desenvolvedores de apps no momento do design. Os produtos de API podem, por sua vez, ser agrupados em pacotes de API para monetização.

Uma chave de API está vinculada a um ou mais produtos de API, aplicando uma vinculação entre um app e o pacote de URIs que o app pode consumir.

Uma abreviação de aplicativo. O termo app passou a se referir a aplicativos de dispositivos móveis que consomem APIs. Os desenvolvedores implementam apps em várias linguagens de programação e usando várias tecnologias e plataformas. Os desenvolvedores que querem consumir APIs registram os apps na organização de um provedor de APIs no Apigee Edge.

Quando o aplicativo é registrado, a Apigee gera uma chave de API e um secret que identificam o aplicativo. O desenvolvedor incorpora a chave de API no app, que apresenta a chave ao fazer solicitações. Os serviços da API implementam a segurança em torno da chave de API por meio de validação direta de chaves de API ou por meio do OAuth.

Contexto de execução de ambiente de execução para proxies de API. Um proxy de API precisa ser implantado em um ambiente antes que a API exposta seja acessível pela rede. Por padrão, as organizações são provisionadas com dois ambientes: test e prod.

• O ambiente de test é normalmente usado para implantar proxies de API durante o desenvolvimento.
• O ambiente prod é normalmente usado para promover proxies de API do ambiente de teste depois que eles tiverem sido totalmente desenvolvidos e testados.

Um contêiner para todos os objetos em uma conta do Apigee Edge, incluindo proxies de API, produtos, pacotes de API, apps e desenvolvedores.

É necessária uma conta de usuário para cada organização da qual você é membro. A maioria dos usuários terá uma conta em apenas uma organização.

Uma etapa de processamento executada como uma unidade atômica e lógica reutilizável em um fluxo de processamento de proxy de API.

A funcionalidade típica baseada em políticas inclui transformar formatos de mensagem, aplicar. controle de acesso, chamar serviços remotos para informações extras, mascarar dados confidenciais de usuários externos, examinar conteúdo de mensagens para possíveis ameaças, armazenar em cache respostas comuns para melhorar o desempenho e assim por diante.

As políticas podem ser executadas condicionalmente com base no conteúdo ou no contexto de uma mensagem de solicitação ou resposta. Por exemplo, uma política de transformação pode ser executada para personalizar um formato de resposta se a mensagem de solicitação tiver sido enviada de um smartphone.

A versão da interface da API voltada para o desenvolvedor.

Por exemplo, pivotaltracker.com/services/v3 ou api.enterprise.apigee.com/v1.

Esse termo se distingue de revisão, que é o pacote numerado de configuração e políticas agrupado em um proxy de API controlado por versão. As interfaces da API têm versões. Os proxies da API têm revisões.