Guia de iniciação Desenvolvimento
Conceitos Guias OAuth2 Postman
Casos Uso Comuns Documentação API App Store
Criar uma app Publicar uma App
Cloud Jasmin DesenvolvimentoPostman
DesenvolvimentoPostman
Postman

POSTMAN

Última alteração a 12/08/2022

O postman permite testar os endpoints dos produtos cloud como o ROSE e o JASMIN, para isso, podes fazer download através dos botões abaixo ou em alternativa fazer fork dos coleções através dos workspaces disponiveis em postman.com/primaverabss-developers

Registo da Aplicação

Se ainda não tens uma entidade PRIMAVERA, começa por registar-te aqui e criar a tua App. Depois de criares a tua App, tens de autorizar o acesso a uma subscrição.

  1. Para autorizar, edita a tua App.
  2. Seleciona o menu Autorização.
  3. Carrega no link Ligação de Pré-visualização da App Store.
  4. Carrega no botão Adicionar e seleciona a subscrição.

Instalar a coleção

Clique no botão abaixo para instalar a coleção do Postman para o ROSE.

Clique no botão abaixo para instalar a coleção do Postman para o JASMIN

Configurar Autenticação

O ROSE e JASMIN usam segurança OAuth 2.0, assim a primeira coisa a fazer antes de utilizar a coleção no postman é configurar a forma como este cliente se vai autenticar junto do produto.

  1. No Postman, selecione o menu Collections.
  2. Selecione a pasta "ROSE API Collection" ou "JASMIN API Collection".
  3. Selecione o separador Authorization.
  4. Na combobox Type, selecione OAuth 2.0.
  5. Na combobox Add authorization data, selecione Request Headers.
  6. Na secção Configure New Access Token, introduza a informação abaixo.
ATRIBUTOINFORMAÇÃO
Token NameO nome do token a utilizar.
Grant TypeSelecionar Authorization Code ou Implicit. Isto depende o tipo de acesso selecionado no registo da tua app.
Callback URLUsar https://www.getpostman.com/oauth2/callback
Auth URLUsar https://identity.primaverabss.com/connect/authorize
Access Token URLUsar https://identity.primaverabss.com/connect/token
Client IDUsar o valor do campo Chave que está na tua app.
Client SecretUsar o segredo gerado no registo da tua app. Este campo não está disponivel se o grant type for Implicit.
ScopeUsar rose-api para o ROSE e application para o JASMIN.
Client Authentication
Usar  Send as Basic Auth header.

Variáveis

Para a coleção funcionar, é necessário dar contexto sobre a subscrição a usar.

  1. No Postman, selecione o menu Collections.
  2. Selecione a pasta "ROSE API Collection" ou "JASMIN API Collection".
  3. Selecione o separador Variables.
VARIÁVEISVALOR
BaseUrlUsar https://app.rose.primaverabss.com/ para o ROSE e https://my.jasminsoftware.com/ para JASMIN
AccountKey/TenantEste valor pode ser obtido do url depois de entrar na aplicação no parâmetro ?account.
SubscriptionKey/OrganizationEste valor pode ser obtido do url depois de entrar na aplicação no parâmetro ?subscription
CompanyKeyCódigo da empresa. Esta variável é usada para as entidades que estão associadas a uma empresa, como por exemplo as faturas.
Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.

login para deixar a sua opinião.

Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
POSTMAN