| Name: | Description: | Size: | Format: | |
|---|---|---|---|---|
| 5.73 MB | Adobe PDF |
Authors
Advisor(s)
Abstract(s)
A E-goi é uma empresa que providencia uma plataforma de marketing digital para clientes com diferentes necessidades e preferências. A API pública que a E-goi oferece a esses clientes possui alguns problemas. Este projeto consistiu na criação de uma nova API pública para a E-goi com a finalidade de substituir a anterior. A API necessitou de suportar o estilo arquitetural REST e protocolo SOAP corretamente, para satisfazer as necessidades de diversos clientes. Precisou também de ter respostas compreensíveis, para que a sua utilização seja facilitada e os clientes se sintam satisfeitos. Este projeto contemplou ainda um sistema de versionamento por serviço, compatível com REST e SOAP que pode ser utilizado para aumentar a longevidade da API.
Perante as necessidades dos clientes e da E-goi, optou-se por uma solução que suporta REST e SOAP num único projeto. Para esse fim foi realizado um estudo sobre o funcionamento de ambos e sobre as API, incluindo controlo de tráfego de utilização e caching. Foi ainda realizado um estudo sobre a evolução das API e da anterior API pública da E-goi, que foi substituída por a desenvolvida neste projeto. Para se apresentar uma visão mais concreta do negócio e do seu valor, realizou-se uma análise de valor deste projeto.
A solução desenvolvida disponibiliza diversos serviços em REST e SOAP, um sistema de erros com os códigos HTTP apropriados, e possui um protótipo da utilização de um sistema de versionamento por serviço num dos recursos, para que, no futuro, se a empresa assim o decidir, essa funcionalidade possa ser disponibilizada.
Para validar que a solução final é adequada, foi realizado um questionário de satisfação, testes de aceitação aos serviços e ao sistema de versionamento. Os dados do tempo de resposta foram obtidos da API pública e da utilização direta da privada, e analisados através de um teste estatístico. Os resultados do questionário demostraram uma maior satisfação com a nova API do que com a anterior.
E-goi is a company that provides a digital marketing platform for clients with different needs and preferences. The public API that E-goi offers to those clients has some problems. This project consisted in the creation of a new public API with the purpose of replacing the previous one. The API needed to support REST architectural style and SOAP protocol correctly, to meet customer needs. It also required to have correctly structured responses, in order to ease its use. This project also contains a service versioning system, compatible with REST and SOAP which can increase the API longevity. According to clients’ and E-goi’s needs, it was chosen a solution that supports both REST and SOAP in a single project. The approach which led to the final result involved a study of both and about API, including API traffic management and caching. It was also studied API evolution and reviewed the old E-goi public API, that was replaced with the one developed in this project. In order to give a more concrete vision of the business and its value, a value analysis was performed for this project. The developed solution provides several services in REST and SOAP, an error system with the appropriate HTTP codes, and contains a prototype of the versioning system integrated in one of the resources, so that, in the future, if the company decides it, that functionality could be delivered. To validate if the final solution meets the requirements, it was created a questionnaire of satisfaction, developed acceptance tests to the services and the versioning system. The response time data was obtained from the public API and the direct use of the private API, and analyzed in a statistical test. The questionnaire results demonstrated a greater satisfaction with the new API than with the previous.
E-goi is a company that provides a digital marketing platform for clients with different needs and preferences. The public API that E-goi offers to those clients has some problems. This project consisted in the creation of a new public API with the purpose of replacing the previous one. The API needed to support REST architectural style and SOAP protocol correctly, to meet customer needs. It also required to have correctly structured responses, in order to ease its use. This project also contains a service versioning system, compatible with REST and SOAP which can increase the API longevity. According to clients’ and E-goi’s needs, it was chosen a solution that supports both REST and SOAP in a single project. The approach which led to the final result involved a study of both and about API, including API traffic management and caching. It was also studied API evolution and reviewed the old E-goi public API, that was replaced with the one developed in this project. In order to give a more concrete vision of the business and its value, a value analysis was performed for this project. The developed solution provides several services in REST and SOAP, an error system with the appropriate HTTP codes, and contains a prototype of the versioning system integrated in one of the resources, so that, in the future, if the company decides it, that functionality could be delivered. To validate if the final solution meets the requirements, it was created a questionnaire of satisfaction, developed acceptance tests to the services and the versioning system. The response time data was obtained from the public API and the direct use of the private API, and analyzed in a statistical test. The questionnaire results demonstrated a greater satisfaction with the new API than with the previous.
Description
Keywords
API REST SOAP Versionamento Versioning