Apps

Na sua página customizada do Developer Portal, em Apps vocẽ pode:

Conexões Sensedia:

Conexões AWS:

Lista de Apps

É necessário estar logado para acessar a página de Apps do Developer Portal.

A página conta com uma ferramenta de busca, que permite filtrar por nome da API ou App.

A imagem abaixo é ilustrativa e pode variar de acordo com a customização feita para o seu Developer Portal.

tela de apps do develop portal

A tabela da lista de Apps tem as seguintes colunas:

  • Icon: ícone cadastrado para a App. O cadastro do ícone é opcional.
    Formatos suportados: JPG/JPEG, PNG, BMP e GIF.
    Tamanho máximo da imagem: 140 x 140 pixels. Tamanho máximo do arquivo: 1 MB.

  • App name: nome cadastrado para a App.
    Tamanho: de 3 a 256 caracteres.

  • Description: descrição cadastrada para a App.
    Tamanho: 3 a 512 caracteres.

  • Credentials: link para obter o Client ID e Client Secret;

  • Status: estado da App em termos de habilitação para uso, podendo ser:

    • Approved: está habilitada para uso;

    • Pending: aguardando por aprovação ou rejeição;

    • Rejected: app que estava pendente e foi rejeitada;

    • Cancelled: app cancelada;

  • Actions:

    • icone de uma lupa em cima de um papel: ver uma visão geral com as informações da App, incluindo descrição, credenciais, lista de APIs (com descrição, versão e revisão da API) e de Access Tokens (com status, data de expiração e owner).

    • ícone de um lápis: editar a API.

Para conexões com gateway Sensedia

Criando uma App

Se seu gateway for Sensedia, siga estes passos para criar uma App:

  1. Acesse o seu Developer Portal.

  2. Clique em Apps, localizado no canto superior direito da tela.
    A imagem abaixo é ilustrativa e pode variar de acordo com a customização feita para o seu Developer Portal.
    botão de Apps

    É necessário:
    * estar logado para utilizar esta funcionalidade; * ter um gateway Sensedia cadastrado.

  3. Clique no botão + CREATE NEW APP.
    A imagem abaixo é ilustrativa e pode variar de acordo com a customização feita para o seu Developer Portal. lista de apps com ênfase no botão para criação de App

  4. Preencha os campos de Basic info (informações básicas) com o nome da App e descrição.
    Se desejar, você pode informar um link e adicionar uma imagem.
    campos de informações básicas da App

  5. Em Available APIs (logo abaixo de Basic info), selecione o gateway Sensedia.
    Administradores: se o gateway não aparecer na lista, verifique o status em Connections.

  6. Selecione uma ou mais APIs.
    É necessário que existam planos cadastrados para as APIs.
    criação de App

  7. Revise as configurações e clique em CONFIRM.
    tela para evisão das configurações da App

A App criada aparecerá na lista de Apps.


Editando uma App

Siga estes passos para editar uma App:

  1. Acesse o seu Developer Portal.

  2. Clique em Apps, localizado no canto superior direito da tela.
    É necessário estar logado para utilizar esta funcionalidade.
    A imagem abaixo é ilustrativa e pode variar de acordo com a customização feita para o seu Developer Portal.
    botão de Apps

  3. Localize a App a ser editada. Você pode fazer uma busca por nome da API ou App.

  4. Na coluna ACTIONS, clique no ícone ícone de um lápis para editar.
    ícone para acessar edição de App

    Apenas Apps com status APPROVED podem ser editadas.

  5. Faça as edições e clique em SAVE.

  6. Confira as informações editadas.
    Estando tudo certo, clique em CONFIRM.

Para conexões com gateway AWS

Criando uma App

O registro de Apps para conexões AWS segue passos semelhantes aos do registro de Apps para conexões Sensedia.

As principais diferenças estão na necessidade de aprovação (dependendo da configuração do webhook) e no fato de que não é necessário ter um plano associado à API.

Se seu gateway for AWS, siga estes passos para criar uma App:

  1. Acesse o seu Developer Portal.

  2. Clique em Apps, localizado no canto superior direito da tela.
    É necessário estar logado para utilizar esta funcionalidade.
    botão de Apps

  3. Clique no botão + CREATE NEW APP.
    A imagem abaixo é ilustrativa e pode variar de acordo com a customização feita para o seu Developer Portal. lista de apps com ênfase no botão para criação de App

  4. Preencha os campos de Basic info (informações básicas) com o nome da App e descrição.
    campos de informações básicas da App

  5. Em Available APIs, selecione o gateway AWS.

  6. Selecione uma ou mais APIs.

  7. Revise as configurações e clique em CREATE.

  • A App criada entra para a lista de Apps do Developer Portal com o status Pending.

  • É necessário que o administrador aprove ou rejeite o registro da App no Portal Manager em Consumers  Apps.

  • Outras ações relacionadas ao gerenciamento de Apps de conexões AWS também são realizadas no Portal Manager.

    • Para a autoaprovação de Apps AWS, configure o Webhook de acordo.


Editando uma App AWS

Siga estes passos para editar uma App:

  1. Acesse o seu Developer Portal.

  2. Clique em Apps, localizado no canto superior direito da tela.
    É necessário estar logado para utilizar esta funcionalidade.
    A imagem abaixo é ilustrativa e pode variar de acordo com a customização feita para o seu Developer Portal.
    botão de Apps

  3. Localize a App a ser editada. Você pode fazer uma busca por nome da API ou App.

  4. Na coluna ACTIONS, clique no ícone ícone de um lápis para editar.
    ícone para acessar edição de App

    Apenas Apps com status APPROVED podem ser editadas.

  5. Faça as edições e clique em SAVE.

  6. Confira as informações editadas.
    Estando tudo certo, clique em CONFIRM.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]