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

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Uma organização é o contêiner de nível superior no Apigee. A organização da Apigee 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:

• Uma organização da Apigee é distinta e subsidiária de uma organização do Google Cloud. Quando você cria uma organização para a Apigee X ou a Apigee híbrida, ela é mapeada para exatamente um projeto do Google Cloud, e a organização da Apigee e o projeto do Google Cloud compartilham um nome. Nem todos os projetos do Google Cloud têm uma organização da Apigee associada.
• Quando a documentação da Apigee usa o termo "organização", ela se refere especificamente a uma organização da Apigee. A documentação da Apigee usa a frase "organização do Google Cloud" para se referir à alternativa.
• Não é possível renomear uma organização do Apigee depois de criada.
• O nome da sua organização da Apigee aparece como o projeto no URL da seção da Apigee no Console do Google Cloud. Exemplo:

  https://console.cloud.google.com/apigee/overview?project=ORG_ID

• Quando você invoca chamadas REST para a API Apigee, o identificador da organização é uma parte obrigatória do caminho. 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/ORG_ID/apis

• É possível criar apenas uma organização, mas você pode ser autorizado em outras organizações como usuário ou administrador com permissões específicas. No Cloud Console, é possível alternar para uma organização diferente, conforme descrito em Como alternar entre suas organizações.

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. As organizações pagas incluem aquelas criadas como parte de um modelo de preços de assinatura ou de pagamento por uso da Apigee.

• Avaliação: uma organização de autosserviço temporária para testar a Apigee. Às vezes chamadas de orgs de avaliação, essas organizações têm limite de tempo e não têm a escalonabilidade e a flexibilidade das organizações de produção.

Consulte também Comparar organizações pagas e de avaliação.

Duração 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.
3. Dia 60:o Google exclui a organização de avaliação.

Organizações da Apigee na hierarquia do Google Cloud

O diagrama a seguir mostra a relação entre as organizações e os ambientes da Apigee e os projetos e as pastas do Google Cloud.

Componentes em uma 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.

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 organização da Apigee pertence a um projeto do Google Cloud, e um projeto pode conter no máximo uma organização. Uma organização contém ambientes, proxies de API, produtos de API, pacotes de API, apps e usuários. 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 ambiente é um ambiente de software isolado, em uma organização, em que você implanta proxies de API. É possível criar vários ambientes em uma organização. Um grupo de ambientes é um conjunto de ambientes com um ou mais nomes de host. O nome do host faz parte do URL usado para chamar proxies da API implantados em qualquer ambiente no grupo de ambientes.
Proxy de API	Um proxy de API é uma interface entre as solicitações de entrada e os serviços de back-end. A entidade de proxy contém as instruções e políticas que a Apigee executa ao processar solicitações de clientes e respostas do back-end.
Produto de API	Uma entidade para publicar APIs. Os produtos de API são publicados no portal do desenvolvedor para consumo por desenvolvedores externos. Um produto de API apresenta uma interface para acessar uma ou mais APIs publicadas. A interface (que pode ser descrita com uma especificação OpenAPI) pode incluir uma combinação de uma ou mais solicitações de API processadas por um ou mais proxies de API. Os usuários de uma organização criam produtos de API. Ao fazer isso, eles podem anexar metadados arbitrários a cada produto de API. Um tipo de metadados usado com frequência pode definir um plano de serviços, que pode especificar limites de acesso em chamadas de API, estabelecer requisitos de segurança, permitir monitoramento e análises, além de fornecer recursos adicionais. O Apigee coleta dados para análise sobre produtos de API.
Provedor de API	A pessoa ou entidade que cria e gerencia proxies e produtos de API. Os desenvolvedores de apps clientes acessam essas APIs publicadas.
Desenvolvedor de apps	Uma organização contém um ou mais desenvolvedores que criam os aplicativos que consomem as APIs (publicadas 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, parceiros ou externos, que podem ou não pagar pelo acesso às APIs. Os desenvolvedores são como clientes que usam suas APIs. Os desenvolvedores precisam ser registrados na organização antes de registrar um app e receber uma chave de API ou outras credenciais do cliente que permitam o acesso às suas APIs. Como provedor de API, cabe a você determinar como adicionar, atualizar ou remover desenvolvedores da organização. É possível adicioná-los manualmente pela UI, criar um portal do desenvolvedor para registrá-los em um site ou definir e implementar 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. Desenvolvedores que criam aplicativos cliente que chamam APIs que exigem verificações de credenciais (como chaves de API ou tokens OAuth) precisam primeiro criar um registro de app na sua organização. Um registro de app fornece ao desenvolvedor a chave de API, um par de chave/secret ou outras credenciais que precisam ser usadas quando o aplicativo cliente chama 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.

A 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.

Se o provedor de API especificar a verificação de chave de API como mecanismo de autorização, o aplicativo cliente precisará transmitir uma chave a cada solicitação às suas APIs. Se essa chave for válida, a Apigee permitirá a solicitação. Como alternativa, se o provedor de API especificar a verificação de token OAuth como mecanismo de autorização, o aplicativo cliente precisará primeiro receber um token OAuth e depois transmiti-lo a cada solicitação às suas APIs. Se esse token for válido, a Apigee permitirá a solicitação. Outros esquemas de autorização personalizados são possíveis.

Como um provedor de API, você precisa definir uma maneira de os desenvolvedores registrarem os aplicativos. Cada registro de app terá uma ou mais chaves ou credenciais associadas. Se você permitir que os desenvolvedores registrem os próprios aplicativos em um portal, eles poderão recuperar a chave ou a credencial necessária para acessar suas APIs, em uma experiência conveniente e de autoatendimento.

No momento do registro do aplicativo, os desenvolvedores podem optar por acessar um único produto de API ou vários. O app de um desenvolvedor usa a mesma chave/credencial para acessar todos os produtos de API associados ao app.

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). Também é possível revogar um desenvolvedor. Nesse caso, todas as credenciais dos apps registrados para esse desenvolvedor ficam inoperantes. A revogação é reversível. No momento em que a Apigee cria a credencial do app, você pode especificar uma expiração para que o desenvolvedor precise receber uma nova chave ou credencial 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 adicionar usuários a uma organização.

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 e 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, para sua empresa, você pode definir várias organizações na Apigee para oferecer suporte a diferentes comunidades de desenvolvedores. No entanto, internamente, as mesmas pessoas criam todos os proxies e produtos de API e, portanto, são membros de todos os organizações.

Você não precisa 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 aqui: interface da Apigee no console do Cloud.

Direitos e faturamento

Se a organização paga usa um modelo de preços de assinatura ou pagamento por uso, os itens que são medidos para fins de faturamento são: ambientes, chamadas de API e implantações de proxy.

Os planos de assinatura permitem que você pague antecipadamente pelos direitos, em troca de descontos significativos. Os planos de assinatura fazem sentido em volumes de consumo mais altos, em que há um número maior de ambientes, um volume alto de chamadas de API ou um grande número de proxies de API gerenciados pelo Apigee. No modelo de pagamento por uso, você paga apenas pelos recursos que usa, mas não tem descontos por volume.

Direitos de assinatura

Organizações	É possível ativar o Apigee em qualquer projeto do Google Cloud. Isso cria uma organização da Apigee para esse projeto. Você pode criar quantas organizações quiser. Assim como não há direito ou cobrança para criar um projeto do Google Cloud, não há direito para criar uma organização da Apigee.
Ambientes	O direito de acesso a ambientes é expresso em unidades. Há um processo de duas etapas para usar um direito de unidade de ambiente: primeiro, você cria um ambiente e depois o anexa a uma organização. Um ambiente conta com o direito à unidade de ambiente quando é anexado a uma organização. Consulte os Limites para conferir o número máximo de ambientes em uma única organização. É possível criar um ambiente da Apigee em uma ou mais regiões do Google Cloud disponíveis. Cada região para a qual um ambiente é mapeado consome uma unidade de ambiente do seu direito. Um ambiente provisionado em uma única região consome uma unidade de ambiente do seu direito. Um ambiente provisionado em duas regiões consome duas unidades de ambiente do seu direito. O uso total de unidades de ambiente é o agregado do número de unidades de ambiente usadas em todas as organizações. O total de direitos de unidade de ambiente é a soma do direito fornecido no nível de assinatura com o direito adicional obtido por meio de pacotes de ambiente. O Google impõe o direito para os ambientes. Não é possível exceder o limite de direito. Se você tentar criar um ambiente que exceda o limite de direitos, vai receber um erro. Você pode ampliar seu direito comprando outros pacotes de ambiente.
Chamadas de API	O Google conta cada chamada de API processada pela Apigee. O total de direitos de chamada de API é a soma do direito fornecido no nível de assinatura com o direito adicional obtido por pacotes de chamadas. Em um plano de assinatura, o Google não aplica o limite de direito a chamadas de API. Se você exceder o direito de chamada de API, a Apigee vai continuar a atender as chamadas de API. O Google vai cobrar pelo uso acima do direito atual. Você pode expandir seu direito de chamada de API a qualquer momento comprando pacotes de chamadas adicionais.
Implantações de proxy	O Google contabiliza cada proxy de API implantado. O total de direitos de implantação de proxy é a soma do direito fornecido no nível de assinatura com o direito adicional obtido com os pacotes de implantação de proxy. Em um plano de assinatura, o Google não limita as implantações de proxy ao seu direito. Se você implantar mais proxies do que seu direito permite, excedendo seu direito de implantação de proxy, a Apigee continuará permitindo a implantação de novos proxies e a atender às chamadas de API. O Google vai cobrar pelo uso acima do direito atual. É possível expandir seu direito de implantação de proxy comprando pacotes de chamadas adicionais.

Para entender melhor, consulte Direitos de assinatura.

Direitos de pagamento por utilização

Organizações	É possível ativar o Apigee em qualquer projeto do Google Cloud. Isso cria uma organização da Apigee para esse projeto. Você pode criar quantas organizações quiser. Assim como não há cobrança para criar um projeto do Google Cloud, no modelo de preços pay-as-you-go, não há cobrança para criar uma organização da Apigee.
Ambientes	É possível anexar vários ambientes à sua organização da Apigee. Há um processo de duas etapas para usar um ambiente: primeiro, você cria o ambiente e, em seguida, o anexa a uma organização. O Google cobra por ambientes que são vinculados a uma organização. É possível criar até 85 ambientes em uma única organização. Para ambientes multirregião, o Google cobra por cada região em que o ambiente está disponível. Você pode escolher qualquer uma das regiões disponíveis do Google Cloud.
Chamadas de API	O Google conta cada chamada de API processada pela Apigee. O Google cobra pelo número de chamadas de API processadas pelos seus ambientes da Apigee. Não há limite. A Apigee é dimensionada automaticamente e continua a veicular chamadas de API, mesmo com o aumento da carga.
Implantações de proxy	O Google contabiliza cada proxy de API implantado. O Google cobra pelo número de proxies de API implantados nos seus ambientes da Apigee.

Para entender melhor, consulte Direitos ao pagamento por utilização.