Boas práticas de integração
Compilamos um conjunto de boas práticas que devem ser observadas na utilização da Web API para assegurar uma experiência positiva dos clientes e utilizadores. Estas boas práticas cobrem vários aspetos do desenvolvimento de aplicações integradas. A segurança e a privacidade dos dados utilizados na Web API é um aspeto muito importante e que deve merecer toda a atenção no desenvolvimento. Em primeiro lugar, é muito importante garantir a segurança dos dados utilizados pela aplicação integrada para aceder à API (como, por exemplo, o ClientId). A responsabilidade pela privacidade destes dados é do developer, que deve ter em atenção que esses dados são usados para identificar a sua aplicação nos nossos sistemas. A PRIMAVERA reserva-se o direito de negar o acesso a aplicações que façam algum tipo de uso indevido da API. Os dados do utilizador como, por exemplo, o username, password ou email são propriedade do utilizador e a sua segurança e privacidade devem ser preservadas em todas as circunstâncias. Por fim, os dados do cliente na qualidade de empresa, também devem ser preservados e geridos com todo o cuidado. Recomenda-se evitar o armazenamento na aplicação integrada deste tipo de informação, extraído através da Web API. A PRIMAVERA não disponibiliza neste momento a possibilidade de fazer o armazenamento das soluções integradas, ainda que essa possibilidade possa vir a ser uma contemplada no futuro. O hosting da aplicação integrada é, portanto, da inteira responsabilidade do developer. Na ótica do cliente final, é importante que a solução (Jasmin/Rose + aplicação integrada) funcione muito bem, com garantias de desempenho e disponibilidade. A equipa da PRIMAVERA está disponível para dar aconselhamento a equipas de desenvolvimento no que diz respeito a estas práticas. É importante que a aplicação integrada faça uma utilização responsável da API na medida em que tem um impacto natural na subscrição real do cliente utilizado nos pedidos. A Web API inclui mecanismos de throttling que garantem a proteção do sistema em situações de denial of service e sobrecarga. Nessas condições, a Web API produzirá erros como resposta aos pedidos. Independentemente desses mecanismos é necessário que a aplicação use a API de uma forma eficiente: Os templates de base de dados são continuamente alvo de melhorias para simplificar a sua utilização, bem como para melhorar a clareza e consistência dos próprios dados. As subscrições criadas anteriormente a novas releases não sofrem qualquer alteração, uma vez que este tipo de alterações no template de dados aplica-se apenas a novas subscrições. No entanto, não é uma prática aconselhável ter hardcoded a chave/nome de dados que são template do produto, uma vez que estes dados são voláteis e podem ser modificados em futuras releases. Neste sentido, o integrador deverá, sempre que possível, ter um código robusto e flexível que evite ao máximo ficar exposto a possíveis alterações de dados base no produto.Segurança e privacidade dos dados
Hosting das soluções integradas
Carga resultante dos pedidos à Web API
Templates de bases de dados