Características da Web API Primavera
O termo API significa “Application Programming Interface” e refere-se tradicionalmente a uma “camada da aplicação” que expõe a sua lógica de negócio de uma forma uniformizada, permitindo que seja utilizada por aplicações externas que pretendam interagir com essa aplicação. No contexto de uma aplicação Web, este termo é sinónimo de uma camada de Web services que as aplicações cliente podem utilizar para obter e/ou atualizar dados da respetiva aplicação. Esses serviços podem assumir diferentes nomes, formas e formatos, mas a tendência atual é permitir o acesso a estas funcionalidades através de API REST. Mais informações sobre as boas práticas de utilização e conceitos em https://restfulapi.net/ REST significa “Representational State Transfer” e é um padrão de design utilizado para criar uma API que utilize o protocolo HTTP como meio de comunicação. O artigo que descreve este “modelo” pode ser consultado em http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm. O protocolo HTTP é uma excelente plataforma para a disponibilização de uma API porque já é utilizado atualmente por todos os dispositivos com ligação à Internet. Na sua essência o HTTP é um sistema de pedido/resposta (request/response). O cliente (a aplicação externa) envia um pedido para um determinado endpoint e esse endpoint (a API) responde. Há vários aspetos do protocolo HTTP importantes no contexto de uma Web API: Numa API REST, os resources são normalmente as entidades disponibilizadas pela aplicação (cliente, artigo, fornecedor, encomenda, etc.). O verbo enviado no pedido indica à API que operação se pretende realizar sobre a entidade. Por exemplo, um GET indica que se pretende obter os dados de uma entidade. Um POST significa que se pretende criar uma nova entidade. Existem convenções comuns implícitas nas API REST que facilitam a sua utilização de uma forma uniforme entre todas as entidades. Eis alguns exemplos de possíveis endereços e pedidos de uma API: A Web API permite aceder a todas as entidades do sistema, permitindo a realização de todas as operações sobre essas entidades (criação, atualização, remoção, consulta e listagem). Para que se possa utilizar a Web API é necessário que se verifiquem as seguintes condições: Endpoints A Web API Jasmin disponibiliza os endpoints de serviço num formato de rotas específico. URL base: A rota tem sempre a mesma estrutura e usa os seguintes elementos variáveis: Exemplo: Em cada um dos endpoints estão disponíveis as operações (verbs) GET, POST ou DELETE. Mais informação: Quais são os endpoints da Web API? Exemplos de Endpoints Como é natural numa Web API REST, o URL e os parâmetros do pedido dependem da operação a realizar. Eis alguns exemplos concretos para a entidade (resource) de encomenda de vendas: Parâmetros de Entrada Como referido acima, os endpoints da Web API requerem a identificação da conta e da subscrição do cliente para todos os pedidos. Para além disso, será necessário fornecer no pedido outros parâmetros, dependendo do endpoint e da operação pretendida. Em alguns casos, esses parâmetros deverão ser especificados nos headers do pedido (como a informação de autenticação). Noutros, devem ser especificados no URL do endpoint (como o identificador da entidade a obter num GET ou o número e tamanho da página ao consultar a lista de uma entidade). Existem ainda casos em que os dados devem ser fornecidos em formato JSON no corpo da mensagem, como na criação de uma entidade. A documentação de referência da Web API especifica exatamente os parâmetros do pedido para cada um dos casos. Resultados Os resultados devolvidos em cada pedido dependem do tipo de pedido e da entidade em causa. Em determinados pedidos, como a anulação de uma entidade, o resultado será apenas um status code. Na generalidade dos casos, o sistema devolve um status code e os dados do resultado no corpo da mensagem. Por exemplo, o resultado da consulta de uma entidade pela sua chave será a entidade toda formatada em JSON. Mais informação: Formato dos pedidos e respostas Autenticação A Web API requer que todos os pedidos efetuados sejam autenticados. O método de autenticação utilizado é o standard OAuth 2.0.O que é uma API?
O que é uma API REST?
Resource Verb Resultado Status Code /products GET A lista de produtos 200 (OK) /products?colour=red GET A lista de produtos que têm a cor vermelha 200 (OK) /products POST Criação de um produto 201 (Created) /products/81 GET Os dados do produto com o id 81 200 (OK) /products/81 PUT Atualização do produto com o id 81 204 (No Content) /products/81 DELETE Remoção do produto com o id 81 204 (No Content) Web API PRIMAVERA
https://baseurl/api/{account}/{subscription}/{module}/{resource}/
https://baseurl/api/9999/9999-9999/sales/invoice/
https://baseurl/api/{tenant}/{subscription}/sales/orders
https://baseurl/api/{tenant}/{subscription}/sales/orders?page=1&pageSize=25
https://baseurl/api/{tenant}/{subscription}/sales/orders
https://baseurl/api/{tenant}/{subscription}/sales/orders/53c4ee41-bd16-41f9-a348-3b24cbb4d8c8
https://baseurl/api/{tenant}/{subscription}/sales/orders/ECL/2017/12
https://baseurl/api/{tenant}/{subscription}/sales/orders/ECL/2017/12
login para deixar a sua opinião.