Criar uma App

A criação de uma App é o primeiro passo a tomar para desenvolver qualquer tipo de integração com os produtos cloud da PRIMAVERA, e desempenha dois papeis muito importantes. Por um lado, depois de submetida a aprovação e aprovada, a App ficará disponível no Marketplace para que os clientes a possam subscrever, e por outro lado define a forma de ligação com os produtos. A forma de ligação da App permite ao programador ter acesso ao token de autorização que deve ser utilizado em todas as chamadas à Web API.

A secção de criação de Apps está dividida em duas áreas que importa conhecer.

Publisher

Nesta subárea é apresentada a lista de publishers associada à conta de utilizador, sendo permitido adicionar e remover publishers. O publisher não é mais do que a informação sobre o produtor da App, que depois ficará visível depois na App Store.

Dashboard

Nesta subárea é permitido consultar, editar, publicar ou remover aplicações, bem como criar ou remover subscrições para testes. No momento as subscrições de testes só são permitidas para o Jasmin.

Criar uma App

Para adicionar uma nova aplicação, siga os seguintes passos:

1. Aceder a apps.primaverabss.com/apps.
2. Selecionar o tipo de produto.
3. Clicar em Developer.
4. Clicar em Create App;
5. Inserir os seguintes dados sobre a aplicação:
   - Product: nome do produto;
   - Key: identificador da aplicação (chave/clienteId que será usada nas aplicações integradoras);
   - Name: o nome público da aplicação;
   - Description: descrição da aplicação;
6. Depois de confirmar, é redirecionado para a página de configuração da aplicação onde terá que preencher todos os dados necessários.

Esta página de configuração está dividida em seis áreas, sendo necessário preencher as seguintes informações:

General:

Deverá preencher os seguintes campos:

• Product: nome do produto;
• Version: versão da aplicação;
• Name: nome público da aplicação;
• Key: identificador da aplicação;
• Publisher Key: identificador do publisher;
• Home Page: o endereço Web da aplicação (para efeitos informativos);
• Description: descrição da aplicação.

Logo & Images:

Nesta área deverá indicar o logótipo da aplicação para efeitos informativos.

Autorization

Esta é a zona mais importante de todo o processo de registo, pois define a forma como será feita a autenticação/autorização, pelo que deverá selecionar o fluxo de acordo com a tipologia da sua aplicação.

• OAuthFlow: Fluxo de autenticação.
• Redirect URI: O endereço da página que será utilizada na autorização.

Ao selecionar os tipos de fluxo Client Credentials ou AuthorizationCode, deverá gerar um Client Secret no botão disponível para o efeito, sendo necessário gravar a aplicação após alteração do fluxo. Não é possível recuperar esta informação, por isso deverá guardá-la de forma segura. Contudo, é possível gerar um novo Client Secret através da opção Reset Client Secret.

Additional Settings

Deverá preencher os seguintes dados:

• App Store Preview Link: o link do preview da aplicação na store. Pode ser utilizado para subscrever a aplicação sem efetuar a publicação da mesma;
• Notifications Endpoint: o endpoint para o envio de notificações para a aplicação;
• External Subscription Url: Url externa de redireccionamento para a aplicação.

Distribution

Após preencher todos os requisitos necessários, é possível submeter a aplicação para aprovação através da opção Submit for approval. Será também apresentado o estado em que se encontra a aprovação da aplicação.

Apenas Apps que sejam para disponibilizar no marketplace é que necessitam de ser submetidas para aprovação.

Editar uma App

Depois de criada é possível editar alguns campos da App, exceto os campos Product, Name e Key.

Poderá também efetuar o publish ou unpublish de aplicações, bem como solicitar a geração de novo Client Secret (esta opção apenas se encontra disponível para aplicações com os tipos de autenticação Client Credentials ou AuthorizationCode).

Associação de Subscrições

Para que a App criada possa aceder aos dados é necessário fazer a associação da App criada a uma dada subscrição. Este é um procedimento que é necessário realizar para efeitos de desenvolvimento e testes. Caso não seja feita a associação quando for realizado um request pela WebApi será devolvido o código de erro 403.

Para associar uma App.

1. Selecionar o produto;
2. Clicar em developer;
3. Clicar na App criada;
4. Navegar até a secção Additional Setting;
5. Clicar no link de navegação em App Store Preview;
6. Clicar em Add
7. Selecionar da lista a subscrição e confirmar.