Noções básicas sobre as organizações

Você está vendo a documentação do Apigee X.
Veja a documentação do Apigee Edge.

Uma organização é o contêiner de nível superior no Apigee. Ela contém todos os proxies de API e recursos relacionados. Embora o restante deste tópico seja mais focado em organizações, veja alguns pontos práticos:

  • Depois de criada, não é possível renomear uma organização.
  • O nome da sua organização está no URL da IU da Apigee. Exemplo:
    https://apigee.google.com/organizations/ORG_ID
  • Quando você faz chamadas com a API Apigee, a organização é uma parte obrigatória do caminho na maioria das chamadas. Por exemplo, a solicitação curl a seguir retorna uma lista de todos os proxies de API em uma organização que usa a API Organizations:
    curl https://apigee.googleapis.com/v1/organizations/YOUR_ORG_ID/apis
  • É possível criar apenas uma organização, mas você pode pertencer a outras organizações como usuário ou administrador com permissões específicas. É possível alternar para uma organização diferente, conforme descrito na seção Como alternar entre suas organizações.
  • Uma organização da Apigee não é igual a uma organização do Google Cloud. Se houver possibilidade de ambiguidade, este documento especifica que a "organização" é uma organização da Apigee.

Vídeo: assista a um breve vídeo para saber como as organizações oferecem suporte a uma arquitetura multilocatária para o gerenciamento de API.

Tipos de organização

Existem dois tipos de organizações:

  • Paga: uma organização permanente com escalonabilidade total. Também conhecida como organização de produção. A criação de uma organização paga requer um contrato com a Apigee.

    A Apigee concede direitos por contrato para que você possa criar esse tipo de organização, conforme descrito em Visão geral e pré-requisitos.

  • Avaliação: uma organização de autosserviço temporária para testar a Apigee. Também conhecidas como eval orgs, essas organizações têm limite de tempo e não têm a escalonabilidade e a flexibilidade das organizações de produção.

    Você cria ou provisiona sua própria organização de avaliação sem nenhum direito, conforme descrito na seção Como criar uma organização de avaliação.

Ciclo de vida da organização de avaliação

As organizações de avaliação têm uma duração limitada:

  1. Dia 0: crie a organização de avaliação.
  2. Dia 30: o Google envia um aviso por e-mail sobre a expiração da avaliação.
  3. Dia 60: o Google exclui a organização de avaliação.

Comparação entre organizações pagas e de avaliação

As organizações pagas e de avaliação têm funcionalidade completa. As diferenças entre eles estão, em grande parte, no escalonamento e nas permissões de infraestrutura, como mostra a tabela a seguir:

Função Tipo de organização Descrição
Paga/Produção Avaliação
Duração Com base no contrato 60 dias Para uma organização de avaliação, após 30 dias você receberá uma notificação alertando que duração é limitada. Após 60 dias, o Google excluirá a organização de avaliação. Não é possível estender a vida útil dela.
Requer peering de VPC? As duas exigem peering de VPC.
Tamanho necessário da rede de peering /16 ou /20 /23 Para mais informações, consulte Intervalos de peering.
Acesso por proxy Acesso externo ou privado/local Acesso externo ou privado/local Por padrão, os proxies de API só podem ser acessados internamente. No entanto, é possível configurar o balanceador de carga para aceitar solicitações externas de uma conta de avaliação ou paga.
Instâncias compatíveis Com base no contrato 1 O número de instâncias do ambiente de execução.
Ambientes Com base no contrato e no intervalo CIDR 2

O número de ambientes de execução. Isso não afeta o número de grupos de ambientes.

A Apigee cria dois ambientes durante o provisionamento. Por isso, uma organização de avaliação precisa excluir um para criar um novo.

Se o intervalo de CIDR for /20, seu número máximo de ambientes será 14. Para mais informações, consulte Intervalos de peering.

Tolerância a falhas no ambiente de execução Regional Zonal

Os ambientes de execução em organizações de avaliação são executados apenas em uma zona. Se essa zona ficar inoperante, a organização de avaliação não estará disponível.

Os ambientes de execução de organizações de produção usam o clustering regional. Isso significa que, se uma zona ficar inativa, a Apigee poderá redirecionar as solicitações para ambientes de execução em outras zonas da região.

Para ver mais informações sobre regiões e zonas, consulte Regiões e zonas.

Dados de análise Regional Regional

Os dados de análise são regionais para ambos.

Escalonabilidade e dimensionamento As organizações de avaliação têm uma infraestrutura limitada/restrita. Elas não são adequadas para testes de desempenho/carregamento.

Para mais informações, consulte Preços da Apigee.

Componentes da organização

A imagem a seguir mostra os principais componentes do modelo organizacional do Apigee. Esse modelo define como suas APIs, produtos de API, aplicativos e desenvolvedores de aplicativos estão relacionados na Apigee.

Diagrama hierárquico mostrando a organização como a raiz de uma implantação da Apigee.

Esse modelo não mostra todos os recursos da Apigee, mas indica que a organização é a raiz de uma implantação.

A tabela a seguir descreve os componentes do modelo organizacional em mais detalhes:

Componente Descrição
Organização

Cada conta do Google Cloud é mapeada para uma organização. A organização contém uma representação de todos os ambiente, além de proxies de API, produtos de API, pacotes e aplicativos de API.

Os proprietários de contas não estão limitados a uma única organização. Alguns proprietários de contas podem definir ou ser membros de várias organizações compatíveis com diferentes comunidades de desenvolvedores de aplicativos.

Ambientes e grupos de ambiente Um contexto de execução do ambiente de execução para os proxies da API em uma organização. Para mais informações, consulte Sobre ambientes e grupos de ambiente.

Proxy de API

Um proxy de API define um mapeamento de um endpoint HTTP disponível publicamente para um serviço de back-end. Os proxies de API também podem ser configurados para incluir a segurança (como OAuth), realizar transformação de mensagem (como XML para JSON), limitar o tráfego aos serviços de back-end e realizar outras operações valiosas na solicitação, a resposta e com chamadas de serviço.

Os usuários de uma organização criam um ou mais proxies de API.

O Google coleta dados para análise em proxies da API.

Produto de API

Um pacote de proxies de API combinados com um plano de serviços. Esse plano de serviços pode especificar limites de acesso em proxies de API, fornecer segurança, permitir monitoramento e análises e oferecer mais recursos.

Os usuários de uma organização criam produtos de API.

O Apigee coleta dados para análise sobre produtos de API.

Provedor de API

A entidade que cria e gerencia proxies de API. Os desenvolvedores de apps clientes acessam proxies da API.

Desenvolvedor de apps

Uma organização contém um ou mais desenvolvedores que criam os aplicativos que consomem as APIs (montadas em produtos de API) definidas pela organização. Os desenvolvedores consomem APIs, mas não podem criar APIs nem realizar outras ações na organização.

Os desenvolvedores podem ser internos da empresa, parceiros ou desenvolvedores externos que pagam pelo acesso às APIs. Pense em alguns desenvolvedores como clientes.

Os desenvolvedores precisam ser registrados na organização antes de registrar um aplicativo e receber uma chave para acessar APIs. Como provedor de API, cabe a você determinar como adicionar, atualizar ou remover desenvolvedores da organização. É possível adicioná-los manualmente por meio da IU, criar um portal do desenvolvedor para registrá-los em um site ou definir seu próprio mecanismo de registro usando a API Apigee.

App Apigee (ou app)

Os desenvolvedores criam um ou mais apps clientes que consomem sua APIs.

Os desenvolvedores precisam registrar os aplicativos na organização. Um app é uma representação do app real de um desenvolvedor que fornece uma chave de API a ser transmitida com todas as solicitações para suas APIs.

Como todos os apps estão registrados na sua organização, é possível usar a Apigee para monitorar e coletar informações analíticas sobre o app e o uso das APIs.

Outros componentes da Apigee que não são mostrados são as chaves de API e os tokens do OAuth.

Dependendo do mecanismo de autorização definido para suas APIs, o aplicativo Apigee transmite uma chave de API com cada solicitação para suas APIs. Se essa chave for válida, a solicitação será permitida.

O Apigee é compatível com diferentes tipos de autenticação, como uma chave de API simples, OAuth de duas etapas, OAuth de três etapas e outros.

Como um provedor de API, você precisa definir uma maneira de os desenvolvedores registrarem os aplicativos. Ao registrar o aplicativo, você retorna ao desenvolvedor a chave necessária para acessar as APIs.

No momento do registro do aplicativo, os desenvolvedores podem optar por acessar um único produto de API ou vários. O aplicativo de um desenvolvedor usa a mesma chave para acessar todos os produtos de API associados a ele (a representação registrada do aplicativo do desenvolvedor na Apigee).

A qualquer momento, é possível revogar a chave para que o aplicativo do desenvolvedor não tenha mais acesso às APIs (mesmo que a representação registrada do aplicativo do desenvolvedor ainda exista na organização). Ou é possível definir um limite de tempo em uma chave para que o desenvolvedor precise atualizar a chave após um período específico.

Usuários da Apigee

Os usuários da Apigee formam a equipe da API da organização, que pode incluir pessoas como administradores, proxy de API e criadores de produtos de API, ou usuários que monitoram análises e outras estatísticas. Os usuários finais são pessoas que utilizam os apps criados pelos desenvolvedores da Apigee. Na maioria dos casos, essa documentação usa o termo "usuário" para se referir a um usuário da Apigee.

Os administradores podem criar mais usuários.

Usuários diferentes podem ter papéis e privilégios de acesso diferentes. Por exemplo, defina alguns usuários como administradores da organização e administradores de operações com privilégios para modificar a organização e os componentes dela. Defina outros usuários com permissões para criar proxies e produtos de API, mas sem os privilégios para modificar outros usuários.

Os usuários podem ser membros de várias organizações. Por exemplo, a empresa pode definir várias organizações na Apigee para dar suporte a diferentes comunidades de desenvolvedores. Internamente, as mesmas pessoas criam todos os proxies e produtos de API. Portanto, eles são membros de todas as organizações.

Você não precisa criar uma conta da Apigee, ou seja, criar uma organização da Apigee, para ser um usuário. Um administrador pode adicioná-lo a uma organização existente.

Todos os usuários fazem login na Apigee pela IU da Apigee.

Direitos

Organizações: quando você autoriza uma nova organização, pode usá-la como uma nova organização em qualquer região que quiser ou estender uma organização existente para uma nova região (usando a expansão de nome de domínio). Por exemplo, se você comprar quatro organizações novas, será possível expandir uma organização existente para quatro novas regiões. Para fins de autorização, uma organização em duas regiões equivale a duas organizações.

O total de autorizações da organização é a soma do nível de assinatura com os pacotes organizacionais relevantes.

Ambientes: as autorizações de ambiente não dependem das autorizações da organização. Elas também se comportam de maneira diferente das autorizações da organização porque há um processo de duas etapas para usá-las: primeiro, você cria um ambiente e, em seguida, vincula esse ambiente a uma organização. Os ambientes não são contabilizados nos seus limites de autorização até que estejam vinculados a uma organização.

Em outras palavras, o número de ambientes contabilizados é o número de ambientes que foram vinculados a uma organização.

O total de autorizações de ambiente é a soma do nível de assinatura com os pacotes relevantes. Todos os ambientes adicionados de um pacote organizacional são independentes e não são vinculados à nova organização. Eles são somados às suas autorizações de ambiente totais.

O uso de ambientes é o número de ambientes usados em todas as organizações e em cada região. Em outras palavras, um ambiente que é provisionado em duas regiões para uma organização contará como dois ambientes no seu limite de autorizações.

Para adicionar mais ambientes sem comprar mais organizações, compre um pacote de ambiente.