Esta é a documentação do Apigee Edge.
Acesse
Documentação da Apigee X. informações
Uma organização é o contêiner de nível superior no Apigee Edge. 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:
- Por padrão, o nome da organização está no URL usado para chamar os proxies da API, conforme
descrito em Sobre hosts virtuais.
Exemplo:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- O nome da organização está no URL da IU de gerenciamento do Edge. Por exemplo, o seguinte URL exibe os proxies de API para a organização
docs:
- É 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. Na IU de gerenciamento do Edge, se você pertencer a mais de uma organização, é possível alternar para uma organização diferente, conforme descrito em Alternar entre suas organizações.
- Quando você faz chamadas com a API de gerenciamento como um usuário no papel de administrador da organização
a organização é uma parte necessária do caminho na maioria das chamadas. Por exemplo, os seguintes
A solicitação cURL da API de gerenciamento retorna uma lista de todos os proxies de API em uma organização:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
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.
Componentes da organização
Quando você cria uma conta do Edge, ele cria uma organização automaticamente para você. Depois de criada, é possível adicionar usuários à organização, criar proxies de API e produtos de API, além de registrar desenvolvedores e apps.
A imagem a seguir mostra os principais componentes do modelo organizacional de borda. Esse modelo define como as APIs, produtos de API, aplicativos e desenvolvedores de aplicativos estão relacionados no Edge.
Esse modelo não mostra todos os recursos do Apigee Edge. Se você usar a monetização, o modelo terá componentes extras. Para mais informações, consulte Visão geral da monetização. Consulte Gerenciar empresas e desenvolvedores para mais informações sobre como gerenciar empresas e desenvolvedores com monetização.
Nomes das organizações
O nome da organização é:
- Organização de avaliação:
username-eval - Organização paga: definida pelo usuário no momento do provisionamento inicial
Depois de criada, não é possível renomear uma organização.
O nome da organização se torna parte do URL dos proxies da API e do URL quando fazendo uma solicitação à API Edge Management. Por exemplo, um URL típico usado para acessar um proxy de API tem este formato:
http://org-name-env.apigee.net/v1/weather/forecastrss
em que:
- org-name é o nome da organização;
- env é o ambiente de implantação do proxy da API, que é teste ou produção.
Exemplo:
http://myorg-test.apigee.net/v1/weather/forecastrss
Componentes da organização
A tabela a seguir descreve os componentes do modelo organizacional em mais detalhes:
| Componente | Descrição |
|---|---|
|
Organização |
Cada conta da Apigee é mapeada para uma ou mais organizações no Apigee Edge. A organização contém uma representação de todos os componentes, incluindo proxies de API, produtos, pacotes de API, apps e desenvolvedores. 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. |
| Ambiente | Um contexto de execução do ambiente de execução para os proxies da API em uma organização. Consulte a seção abaixo para saber mais sobre ambientes. |
|
Usuário |
Em uma organização, como a pessoa que cria a conta é automaticamente administrador, é possível criar mais usuários. Os usuários formam a equipe de API da organização, que pode incluir pessoas como administradores, criadores de produtos de API e proxy de API, usuários monitorando análises e outras estatísticas, entre outros. 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, sua empresa pode definir várias organizações no Apigee Edge para oferecer 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 do Apigee, ou seja, criar uma organização do Apigee, para ser um usuário. Um administrador pode adicioná-lo a uma organização atual. Todos os usuários fazem login no Apigee Edge aqui: https://enterprise.apigee.com. |
|
Proxy de API |
Os usuários de uma organização criam um ou mais proxies 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. O Edge coleta dados para análise em proxies de API. |
|
Produto de API |
Os usuários de uma organização criam um ou mais produtos de API, em que um produto de API é um pacote de proxies de API combinados com um plano de serviço. Esse plano de serviços pode definir limites de acesso em proxies de API, fornecer segurança, permitir monitoramento e análises e fornecer mais recursos. O Edge coleta dados para análise de produtos de API. |
|
Desenvolvedor |
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. 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. Eles podem ser adicionados manualmente pela IU de gerenciamento do Edge, criar um portal do desenvolvedor para registrá-los em uma ou defina seu próprio mecanismo de registro usando a plataforma de gerenciamento API. Um desenvolvedor não precisa ter uma conta no Edge, e a maioria dos desenvolvedores não não precisa saber nada sobre o Edge. Se o desenvolvedor tiver uma conta no Edge, normalmente como um usuário em uma organização diferente ou para usar os serviços da API Edge. |
|
App |
Os desenvolvedores criam um ou mais aplicativos clientes que consomem APIs. Os desenvolvedores precisam registrar os aplicativos na organização. Um aplicativo no Edge é uma representação do aplicativo real de um desenvolvedor que fornece ao desenvolvedor uma chave de API para passar a cada solicitação para APIs. Como todos os aplicativos estão registrados na organização, use o Edge para monitorar e coletar informações analíticas sobre o aplicativo e o uso das APIs. |
|
Chave de API/token do OAuth |
Dependendo do mecanismo de autorização definido para APIs, o aplicativo passa uma chave de API com cada solicitação para as APIs. Se essa chave for válida, a solicitação será permitida. O Edge oferece suporte a diferentes tipos de autenticação, como uma chave de API simples, OAuth de duas etapas, OAuth de três etapas, entre 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, o desenvolvedor pode optar por acessar um único produto de API ou vários produtos de API. O aplicativo do desenvolvedor usa a mesma chave para acessar todos os produtos de API associados ao aplicativo (a representação registrada do aplicativo do desenvolvedor no Edge). 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. |
Sobre os ambientes
Um ambiente é um contexto de execução de ambiente para os proxies de API em uma organização. Você precisa implantar um proxy de API em um ambiente antes de poder ser acessado. É possível implantar um proxy de API em um único ambiente ou em vários.
Uma organização pode conter vários ambientes. Por exemplo, você pode definir um dev,
test e prod em uma organização.
A organização fornece escopo para alguns recursos da Apigee. Por exemplo, mapa de chave-valor (KVM) os dados podem ser disponibilizados no nível da organização, ou seja, os proxies de API implantados receberia os mesmos dados da KVM. Alguns recursos, como armazenamento em cache, podem ter escopo para a organização ou para um ambiente específico dentro da organização. Os dados de análise da Apigee são particionados por uma combinação de organização e ambiente.
Veja abaixo as principais entidades que você gerencia em uma organização, incluindo as definidas globalmente na organização e aquelas definidas especificamente para um ambiente:
