APP

App é uma aplicação que consome as APIs oferecidas.

  • Na maioria das vezes, uma App irá consumir APIs em nome de um parceiro (cadastro de produtos em nome de um lojista, consulta de crédito em nome de um parceiro, etc);

  • Em alguns casos, não envolve um parceiro (consulta de produtos, consulta de crédito, trending topics, etc);

  • Uma App é identificada por seu Client ID.

Cadastro de APP

A tela de visualização e cadastro de App pode ser acessada via menu lateral, como ilustrado abaixo:

Para cadastrar uma App, deve-se clicar em "Create App" -- botão no canto direito inferior da tela (+) -- e será habilitado um wizard para ajudar no cadastro.

Overview

O primeiro passo será a tela de Overview. Nela temos os seguintes campos para serem preenchidos obrigatoriamente:

  • App Name: Serve para identificar o nome de uma App;

  • Description: Descrição para ajudar na identificação de uma App;

  • Status: Permite definir o estado de cada App.

    • APPROVED: App está habilitada para uso;

    • PENDING: App aguardando por aprovação ou rejeição;

    • REJECTED: App estava pendente e foi rejeitada;

    • CANCELLED: App cancelada para uso.

  • Developer: Poderá assumir 2 comportamentos:

    • Tem função de vincular um Client ID a um usuário do Portal. Este campo também possui um autocomplete com a listagem dos usuários cadastrados através do Portal e podem ser visualizados na tela de 'Developers' do Manager.

    • Caso um determinado usuário queira ter acesso ao Client ID e ao Client Secret, passa a ser obrigatório informar o email do respectivo usuário nesse campo.

  • Client ID e Client Secret: São campos gerados automaticamente pelo Manager para garantir a unicidade. Mas, podem ser inseridos manualmente pelo usuário, aceitando apenas letras e números em seus campos;

  • Link to App store or App site: Se houver o link da App publicada.

  • Show this in App Gallery: Caso esteja marcado, a App é exibido no App Gallery no Portal;

  • Extra Fields: São todos campos que agregam valor e complementam as informações do Client ID. Exemplo, um ID.

Plans

O segundo passo será a tela de Plans. Nesta parte devemos selecionar quais APIs a App irá consumir e quais planos ela deve seguir.

Os planos estão vinculados a uma API. Logo, deve-se selecionar a API e em seguida, quais planos dessa API a App irá pertecer:

Após a seleção, deve-se clicar em "SAVE PLAN" para validação do(s) plano(s) escolhido(s). Caso apenas a API seja escolhida sem a seleção de um plano, o plano default da API será usado após o cadastro da App ser efetivado.

Se nenhuma API ou plano for selecionado, a App não poderá consumir nenhuma API. Porém, este vínculo não é obrigatório na criação da App, podendo ser vinculado posteriormente.

Para o caso de existir na listagem uma API que não possui um ou mais planos associados, o card de seleção exibirá a seguinte mensagem: "Heads up! This API needs a Plan to be consumed by your App". Será habilitado abaixo do card um botão Create Plan, clicando nele o usuário será direcionado para a tela de cadastro de Planos, onde o novo plano poderá ser vinculado a API. Um exemplo de API deste tipo é mostrado na imagem abaixo:

Summary

O terceiro e último passo é a tela de Summary. Nesta parte temos o resumo de todos os dados inseridos para a criação da App. Aqui podemos verificar se o cadastro está de acordo. Caso queira alterar algum passo, basta clicar no passo desejado através do wizard e alterar o item, se não, apenas clique em 'PUBLISH YOUR APP' para salvar.

Após salvo, o usuário será direcionado para uma tela de sucesso onde serão exibidas informações sobre o Client ID e Secret, que podem ser copiados através do botão COPY. Caso o usuário deseje associar a APP criada a um Access Token, basta clicar em Create Access Token e realizar o processo. Mais informações sobre criação e associação de Access Tokens podem ser encontrados aqui

O Summary também poderá ser acessado na tela de listagem de Apps. Para isso, basta clicar no nome da App. Nesta tela, será possível visualizar todas as informações da App e também todos os Access Tokens associados a essa App.

Edição de App

Para editar os dados de uma App, basta clicar em "Edit" na listagem de Apps, conforme mostra a figura abaixo:

Exclusão de APP

Para excluir uma App, basta clicar em "Delete" na listagem de Apps, conforme mostra a figura abaixo: