Thanks for your feedback!
EDIT
Apps
| A página é exclusiva para o gerenciamento de Apps de conexões Sensedia e AWS. |
Após a criação feita na página de Apps do seu Developer Portal, a App será listada no Portal Manager em .
Nesta tela, você pode realizar as seguintes ações relacionadas a uma App AWS:
-
Aprovar o registro e configurar a autenticação.
-
Rejeitar o registro.
-
Visualizar detalhes.
-
Buscar Apps.
-
Veja a descrição de cada coluna da lista de Apps AWS.
-
-
Excluir a App.
-
Cancelar o registro.
Veja como editar uma App AWS em Developer Portal > Apps.
As ações que podem ser realizadas dependem do status da App:
| Status | Ações possíveis |
|---|---|
|
aprovar, rejeitar e visualizar |
|
cancelar, editar e visualizar |
|
aprovar, deletar e visualizar |
|
aprovar, deletar e visualizar |
Aprovando o registro de uma App AWS
Assim que uma Apps AWS é registrada, ela fica disponível na lista de Apps AWS com o status PENDING.
Se você concorda e deseja aprovar o registro, siga os passos abaixo:
-
Acesse o menu .
-
Localize a App AWS que deseja aprovar.
-
Clique em
na coluna Actions.
-
Uma janela de confirmação será exibida.
Na aba APP APPROVAL, selecione o tipo de credencial para autenticação e preencha os campos obrigatórios.
-
Clique em APPROVE para confirmar a ação.
Autenticação
Para realizar a autenticação, você deve selecionar a forma de autenticação (tipo de credencial), que pode ser:
-
Client Credentials:
-
Client ID: informe seu Client ID.
-
Client Secret: informe seu Client Secret.
-
-
API Key:
-
AWS API Key: informe sua API Key.
-
-
Webhook credentials:
-
As credenciais do webhook devem estar configuradas no seu sistema.
-
| Para Apps com APIs multirregião, confira se suas credenciais estão devidamente configuradas na AWS. |
Rejeitando o cadastro de uma App AWS
Para rejeitar o cadastro de uma App AWS, siga os passos abaixo:
-
Acesse o menu .
-
Localize a App AWS que deseja rejeitar.
-
Clique no X na coluna Actions.
-
Uma janela de confirmação será exibida.
Clique em REJECT para confirmar a ação.
Apenas Apps com status PENDING podem ser rejeitadas.Uma App que foi rejeitada pode ser aprovada novamente ou excluída. |
Visualizando detalhes de uma App AWS
A lista de Apps AWS exibe informações básicas sobre cada App:
-
App Name: nome da App.
-
Integration: nome da conexão AWS.
-
Developer: nome do desenvolvedor responsável.
-
Credential Status: status atual da App.
-
Created At: data de criação da App.
-
APIS: APIs que compõem a App.
-
API Name: nome da API.
-
Description: descrição da API.
-
Plans: planos associados à API.
-
-
Actions: ações disponíveis para a App.
Buscando Apps AWS
Utilize a ferramenta de busca para encontrar uma App específica.
Campos disponíveis para busca:
-
App Name: nome da App.
-
Connection: nome da conexão AWS.
-
Developer: nome do desenvolvedor responsável.
-
Status: status atual da App.
Para ver o campo de busca por Status, clique no ícone de filtro:
.
Deletando uma App AWS
Para excluir uma App AWS, siga os passos abaixo:
-
Acesse o menu .
-
Localize a App AWS que deseja excluir.
-
Clique em
na coluna Actions.
-
Uma janela de confirmação será exibida.
Clique em DELETE para confirmar a ação.
Apenas Apps com status REJECTED ou CANCELED podem ser excluídas.
|
Cancelando o cadastro de uma App AWS
Uma App AWS cujo cadastro foi aprovado anteriormente pode ser cancelada. Siga os passos abaixo:
-
Acesse o menu .
-
Localize a App AWS que deseja cancelar.
-
Clique no X na coluna Actions.
Apenas Apps com status APPROVED podem ser canceladas.
|
Sincronização de status das apps
O Developer Portal e o API Management mantêm uma sincronização bidirecional dos status das apps, garantindo que qualquer alteração feita por administradores seja refletida automaticamente em ambos os sistemas. Por exemplo, ao excluir uma app no gateway de origem, ela será removida também do Portal Manager e do Developer Portal, e o consumer será notificado sobre a revogação de acesso.
Atualização de status pelo Portal Manager
-
Aprovação (APPROVED): ao aprovar uma app no Portal Manager, o status é imediatamente atualizado no API Management.
-
Rejeição (REJECTED): ao rejeitar uma app, o status é refletido no API Management e a app não é criada.
-
Cancelamento (CANCELED): ao cancelar uma app, o status é atualizado no API Management, que passa a gerenciar esse status.
-
Pendente (PENDING): esse status nunca é enviado ao API Management, apenas atualiza o escopo da app localmente.
| Caso o consumer altere o escopo de uma app já aprovada, essa modificação não impactará o status da app no API Management. |
Atualização de status pelo API Management
-
Se uma app for marcada como APPROVED, REJECTED ou CANCELED no API Management, o status correspondente será atualizado no Portal Manager.
| Essas alterações também afetam as permissões de acesso às credenciais no Developer Portal. |
| A sincronização bidirecional de status é obrigatória para o API Management (Sensedia Platform). |
Exclusão automática de apps
Quando uma app é excluída no Manager de origem (Sensedia, AWS ou outros), ela será automaticamente removida do Developer Portal. Os cenários possíveis são:
-
Sincronização automática: ao receber um evento de exclusão do API Management de origem, a remoção é realizada automaticamente na base do portal.
-
Exclusão pelo administrador: se o administrador tentar excluir a app no Portal Manager e ela não for encontrada no Manager de origem, o sistema entende que já foi excluída e finaliza a remoção localmente, exibindo uma mensagem informativa.
-
Exclusão pelo consumer: se o desenvolvedor tentar visualizar as credenciais de uma app no Developer Portal e a referência não for localizada no Manager de origem, o sistema entende que já foi excluída e finaliza a remoção localmente, exibindo uma mensagem informativa.
Notificação de exclusão para o consumer
Em todos os cenários acima, o evento de e-mail DeleteApp será enviado ao proprietário da app, informando sobre a exclusão e a perda de acesso.
Share your suggestions with us!
Click here and then [+ Submit idea]