Web Application Programming Interfaces (Apis): General-Purpose Standards, Terms and European Commission Initiatives

Total Page:16

File Type:pdf, Size:1020Kb

Web Application Programming Interfaces (Apis): General-Purpose Standards, Terms and European Commission Initiatives Web Application Programming Interfaces (APIs): general-purpose standards, terms and European Commission initiatives APIs4DGov study — digital government APIs: the road to value-added open API-driven services Santoro, M., Vaccari, L., Mavridis, D., Smith, R. S., Posada, M., Gattwinkel, D. 2019 EUR 29984 EN This publication is a Technical report by the Joint Research Centre (JRC), the European Commission’s science and knowledge service. It aims to provide evidence-based scientific support to the European policymaking process. The scientific output expressed does not imply a policy position of the European Commission. Neither the European Commission nor any person acting on behalf of the Commission is responsible for the use that might be made of this publication. For information on the methodology and quality underlying the data used in this publication for which the source is neither Eurostat nor other Commission services, users should contact the referenced source. The designations employed and the presentation of material on the maps do not imply the expression of any opinion whatsoever on the part of the European Union concerning the legal status of any country, territory, city or area or of its authorities, or concerning the delimitation of its frontiers or boundaries. Contact information Name: European Commission, Joint Research Centre (JRC), Digital Economy Unit (JRC.B6) Address: Via Enrico Fermi, 2749 — 21027 Ispra (VA), Italy Email: [email protected] Tel.: +39 0332 78 57 58 EU Science Hub https://ec.europa.eu/jrc JRC118082 EUR 29984 EN PDF ISBN 978-92-76-13183-0 ISSN 1831-9424 doi:10.2760/675 Luxembourg: Publications Office of the European Union, 2019 © European Union, 2019 The reuse policy of the European Commission is implemented by the Commission Decision 2011/833/EU of 12 December 2011 on the reuse of Commission documents (OJ L 330, 14.12.2011, p. 39). Except otherwise noted, the reuse of this document is authorised under the Creative Commons Attribution 4.0 International (CC BY 4.0) licence (https://creativecommons.org/licenses/by/4.0/). This means that reuse is allowed provided appropriate credit is given and any changes are indicated. For any use or reproduction of photos or other material that is not owned by the EU, permission must be sought directly from the copyright holders. All content © European Union, 2019, except: cover page, BlooblGum, 193379769, 2019. Source: AdobeStock.com How to cite this report: Santoro, M., Vaccari, L., Mavridis, D., Smith, R., Posada M. and Gattwinkel D., Web APIs: general-purpose standards, terms and European Commission initiatives, EUR 29984 EN, Publications Office of the European Union, Luxembourg, 2019, ISBN 978-92- 76-13183-0, doi:10.2760/675, JRC118082. How to cite the list of standards on which this report is based on: Vaccari, L. and Santoro, M., API standards and technical specifications - APIs4DGov, European Commission, Joint Research Centre (JRC), 2019 [Dataset] PID: http://data.europa.eu/89h/5a431f38-1e2c-449a-898e-34f2a3234c3b. Contents Preface .........................................................................................................................................................................................................................................................................1 Acknowledgements ..........................................................................................................................................................................................................................................2 Abstract .......................................................................................................................................................................................................................................................................3 1 Introduction.....................................................................................................................................................................................................................................................4 1.1 Scope of the report ....................................................................................................................................................................................................................5 1.2 Definitions ..........................................................................................................................................................................................................................................5 1.2.1 Application Programming Interfaces ......................................................................................................................................................5 1.2.2 Web APIs and Web Services ...........................................................................................................................................................................6 1.2.2.1 Trends in the adoption of web APIs ...........................................................................................................................................6 1.2.3 Remote Procedure Call and Representational State Transfer ........................................................................................ 7 1.2.4 API maturity models ............................................................................................................................................................................................10 1.2.4.1 Amundsen maturity model ..............................................................................................................................................................10 1.2.4.2 Richardson maturity model .............................................................................................................................................................10 1.2.5 Microservices ..............................................................................................................................................................................................................11 2 Presentation of the documents ................................................................................................................................................................................................13 2.1 Methodology..................................................................................................................................................................................................................................13 2.2 Shortlist of technical specifications and standards ................................................................................................................................14 2.2.1 Functional specification ...................................................................................................................................................................................15 2.2.1.1 Resource representation ....................................................................................................................................................................15 2.2.1.1.1 Hypermedia specification ...............................................................................................................................................15 2.2.1.1.2 Repositories of media and link relation types ............................................................................................16 2.2.1.1.3 Vocabularies ................................................................................................................................................................................17 2.2.1.2 Communication protocol ....................................................................................................................................................................17 2.2.1.2.1 GraphQL...........................................................................................................................................................................................18 2.2.1.2.2 gRPC ....................................................................................................................................................................................................18 2.2.1.2.3 SPARQL .............................................................................................................................................................................................18 2.2.1.2.4 WebSocket ....................................................................................................................................................................................19 2.2.1.2.5 XML -RPC and JSON-RPC ..................................................................................................................................................19 2.2.2 Security ............................................................................................................................................................................................................................19 2.2.2.1 Authentication ..............................................................................................................................................................................................20 2.2.2.1.1 API key ..............................................................................................................................................................................................20
Recommended publications
  • A Microkernel API for Fine-Grained Decomposition
    A Microkernel API for Fine-Grained Decomposition Sebastian Reichelt Jan Stoess Frank Bellosa System Architecture Group, University of Karlsruhe, Germany freichelt,stoess,[email protected] ABSTRACT from the microkernel APIs in existence. The need, for in- Microkernel-based operating systems typically require spe- stance, to explicitly pass messages between servers, or the cial attention to issues that otherwise arise only in dis- need to set up threads and address spaces in every server for tributed systems. The resulting extra code degrades per- parallelism or protection require OS developers to adopt the formance and increases development effort, severely limiting mindset of a distributed-system programmer rather than to decomposition granularity. take advantage of their knowledge on traditional OS design. We present a new microkernel design that enables OS devel- Distributed-system paradigms, though well-understood and opers to decompose systems into very fine-grained servers. suited for physically (and, thus, coarsely) partitioned sys- We avoid the typical obstacles by defining servers as light- tems, present obstacles to the fine-grained decomposition weight, passive objects. We replace complex IPC mecha- required to exploit the benefits of microkernels: First, a nisms by a simple function-call approach, and our passive, lot of development effort must be spent into matching the module-like server model obviates the need to create threads OS structure to the architecture of the selected microkernel, in every server. Server code is compiled into small self- which also hinders porting existing code from monolithic sys- contained files, which can be loaded into the same address tems. Second, the more servers exist | a desired property space (for speed) or different address spaces (for safety).
    [Show full text]
  • Security in Cloud Computing a Security Assessment of Cloud Computing Providers for an Online Receipt Storage
    Security in Cloud Computing A Security Assessment of Cloud Computing Providers for an Online Receipt Storage Mats Andreassen Kåre Marius Blakstad Master of Science in Computer Science Submission date: June 2010 Supervisor: Lillian Røstad, IDI Norwegian University of Science and Technology Department of Computer and Information Science Problem Description We will survey some current cloud computing vendors and compare them to find patterns in how their feature sets are evolving. The start-up firm dSafe intends to exploit the promises of cloud computing in order to launch their business idea with only marginal hardware and licensing costs. We must define the criteria for how dSafe's application can be sufficiently secure in the cloud as well as how dSafe can get there. Assignment given: 14. January 2010 Supervisor: Lillian Røstad, IDI Abstract Considerations with regards to security issues and demands must be addressed before migrating an application into a cloud computing environment. Different vendors, Microsoft Azure, Amazon Web Services and Google AppEngine, provide different capabilities and solutions to the individual areas of concern presented by each application. Through a case study of an online receipt storage application from the company dSafe, a basis is formed for the evaluation. The three cloud computing vendors are assessed with regards to a security assessment framework provided by the Cloud Security Alliance and the application of this on the case study. Finally, the study is concluded with a set of general recommendations and the recommendation of a cloud vendor. This is based on a number of security as- pects related to the case study’s existence in the cloud.
    [Show full text]
  • Openvms Record Management Services Reference Manual
    OpenVMS Record Management Services Reference Manual Order Number: AA-PV6RD-TK April 2001 This reference manual contains general information intended for use in any OpenVMS programming language, as well as specific information on writing programs that use OpenVMS Record Management Services (OpenVMS RMS). Revision/Update Information: This manual supersedes the OpenVMS Record Management Services Reference Manual, OpenVMS Alpha Version 7.2 and OpenVMS VAX Version 7.2 Software Version: OpenVMS Alpha Version 7.3 OpenVMS VAX Version 7.3 Compaq Computer Corporation Houston, Texas © 2001 Compaq Computer Corporation Compaq, AlphaServer, VAX, VMS, the Compaq logo Registered in U.S. Patent and Trademark Office. Alpha, PATHWORKS, DECnet, DEC, and OpenVMS are trademarks of Compaq Information Technologies Group, L.P. in the United States and other countries. UNIX and X/Open are trademarks of The Open Group in the United States and other countries. All other product names mentioned herein may be the trademarks of their respective companies. Confidential computer software. Valid license from Compaq required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor’s standard commercial license. Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information in this document is provided "as is" without warranty of any kind and is subject to change without notice. The warranties for Compaq products are set forth in the express limited warranty statements accompanying such products. Nothing herein should be construed as constituting an additional warranty.
    [Show full text]
  • Web API and Microsoft Azure
    [ 1 ] www.it-ebooks.info Building Web Services with Microsoft Azure Quickly develop scalable, REST-based applications or services and learn how to manage them using Microsoft Azure Alex Belotserkovskiy Stephen Kaufman Nikhil Sachdeva professional expertise distilled PUBLISHING BIRMINGHAM - MUMBAI www.it-ebooks.info Building Web Services with Microsoft Azure Copyright © 2015 Packt Publishing All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews. Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the authors, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book. Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information. First published: May 2015 Production reference: 1220515 Published by Packt Publishing Ltd. Livery Place 35 Livery Street Birmingham B3 2PB, UK. ISBN 978-1-78439-837-8 www.packtpub.com www.it-ebooks.info Credits Authors Copy Editors Alex Belotserkovskiy Pranjali
    [Show full text]
  • Open Cloud Computing with the Simple Cloud API and Apache Libcloud Doug Tidwell Cloud Computing Evangelist, IBM [email protected]
    Open Cloud Computing with the Simple Cloud API and Apache libcloud Doug Tidwell Cloud Computing Evangelist, IBM [email protected] Session 7665 Agenda • Portability and interoperability • A few words about APIs • The Simple Cloud API • Storage • Queues • Documents • Controlling VMs with Apache libcloud • Resources / Next steps The problem Vendor lock-in • If there’s a new technology, any talented programmer will want to use it. • Maybe the shiny new thing is appropriate for what we’re doing. • Maybe not. • We’re probably going to use it anyway. • The challenge is to walk the line between using the newest, coolest thing and avoiding vendor lock-in. Portability and Interoperability • In writing flexible code for the cloud, there are two key concepts: • Portability is the ability to run components or systems written for one cloud provider in another cloud provider’s environment. • Interoperability is the ability to write one piece of code that works with multiple cloud providers, regardless of the differences between them. How standards work • For a standards effort to work, three things have to happen: • The standard has to solve a common problem in an elegant way. • The standard has to be implemented consistently by vendors. • Users have to insist that the products they use implement the standard. How standards work • All three things have to happen. • If the standard doesn't solve a common problem, or if it solves it in an awkward way, the standard fails. • If the standard isn't implemented by anyone, the standard fails. • If customers buy and use products even though they don't implement the standard, the standard fails.
    [Show full text]
  • A Field Guide to Web Apis by Kin Lane Contents
    A field guide to web APIs By Kin Lane Contents Executive summary 4 What are APIs used for? 5 Open data . 5 Websites . 5 Mobile . 5. Automobiles . 6. Homes and buildings . 6 Why are web APIs different? 7 They build on existing web architecture . 7. Intuitive resources . 7 Simplicity rules . 8. Easy to understand for developers and even nondevelopers . 8. Self-service resources . 8 . History of web APIs 9 Commerce . 9 . Social . 9 . Cloud computing . .9 . Mobile . .10 . What technology goes into an API? 11 REST . 11. JSON . 11 Security . 11 . Keys . 11 . Basic auth . 12 Open authorization . 12 . Webhooks . 12 Deploying your web API 13 Do-it-yourself approaches . 13 Cloud solutions . 13 . Enterprise gateways . 13 . Established practices for managing APIs 14 Self-service . 14 . Getting started . .14 . Documentation . 15 . Code samples . 15. 2 A field guide to web APIs Support and feedback loops . 15 . The legal aspect . 15. Developer dashboard . 16 Marketing and API evangelism 17 Goals . 17 User engagement . .17 . Blogging . 17 Landscape analysis . 18 . GitHub . .18 . Social . 18. Events . 19. The future of web APIs 20 API aggregation . 20 . Real-time APIs . 20. Backend as a Service (BaaS) . 20 . Automation . 20 Voice . 21. Internet of things . 21. Cloud trends 22 Maturity of IaaS layer . 22. Opportunities in the PaaS layer . .22 . Key takeaways 23 About Kin Lane 23 3 A field guide to web APIs Executive summary A new breed of web API has emerged, delivering a vision of a lightweight, low-cost approach to connect devices and allowing applications to exchange data efficiently. This research report is a field guide for web API providers, developers, and even nondevelopers .
    [Show full text]
  • Vector Screencast
    Charles University in Prague Faculty of Mathematics and Physics BACHELOR THESIS Simonˇ Rozs´ıval Vektorov´yscreencast Department of Distributed and Dependable Systems Supervisor of the bachelor thesis: Mgr. Martin Dˇeck´y Study programme: Computer science Specialization: Programming and software systems Prague 2015 I would like to thank my supervisor, Martin Dˇeck´y, for his valuable pieces of advice, and Otakar J´ıcha from Khanova ˇskola, for the idea of this project and for lending me a graphics tablet for testing. I would also like to thank my family and friends for supporting me during my studies. I declare that I carried out this bachelor thesis independently, and only with the cited sources, literature and other professional sources. I understand that my work relates to the rights and obligations under the Act No. 121/2000 Coll., the Copyright Act, as amended, in particular the fact that the Charles University in Prague has the right to conclude a license agreement on the use of this work as a school work pursuant to Section 60 paragraph 1 of the Copyright Act. In ........ date ............ signature of the author N´azev pr´ace: Vektorov´yscreencast Autor: Simonˇ Rozs´ıval Katedra: Katedra distribuovan´ych a spolehliv´ych syst´em˚u Vedouc´ıbakal´aˇrsk´epr´ace: Mgr. Martin Dˇeck´y Abstrakt: C´ılem bakal´aˇrsk´epr´ace je vytvoˇrit software pro z´aznam a pˇrehr´av´an´ı v´yukov´ych vide´ıpro potˇreby Khanovy ˇskoly. Na rozd´ılod bˇeˇzn´ych vide´ınejsou obrazov´adata uloˇzena ve formˇebitmap, ale jako vektory, coˇz umoˇzn´ısn´ıˇzit da- tovou n´aroˇcnost a vykreslit obraz ostˇre pˇri libovolnˇevelk´em rozliˇsen´ıobrazovky uˇzivatele.
    [Show full text]
  • Ioc Containers in Spring
    301AA - Advanced Programming Lecturer: Andrea Corradini [email protected] http://pages.di.unipi.it/corradini/ AP-2018-11: Frameworks and Inversion of Control Frameworks and Inversion of Control • Recap: JavaBeans as Components • Frameworks, Component Frameworks and their features • Frameworks vs IDEs • Inversion of Control and Containers • Frameworks vs Libraries • Decoupling Components • Dependency Injection • IoC Containers in Spring 2 Components: a recap A software component is a unit of composition with contractually specified interfaces and explicit context dependencies only. A software component can be deployed independently and is subject to composition by third party. Clemens Szyperski, ECOOP 1996 • Examples: Java Beans, CLR Assemblies • Contractually specified interfaces: events, methods and properties • Explicit context dependencies: serializable, constructor with no argument • Subject to composition: connection to other beans – Using connection oriented programming (event source and listeners/delegates) 3 Towards Component Frameworks • Software Framework: A collection of common code providing generic functionality that can be selectively overridden or specialized by user code providing specific functionality • Application Framework: A software framework used to implement the standard structure of an application for a specific development environment. • Examples: – GUI Frameworks – Web Frameworks – Concurrency Frameworks 4 Examples of Frameworks Web Application Frameworks GUI Toolkits 5 Examples: General Software Frameworks – .NET – Windows platform. Provides language interoperability – Android SDK – Supports development of apps in Java (but does not use a JVM!) – Cocoa – Apple’s native OO API for macOS. Includes C standard library and the Objective-C runtime. – Eclipse – Cross-platform, easily extensible IDE with plugins 6 Examples: GUI Frameworks • Frameworks for Application with GUI – MFC - Microsoft Foundation Class Library.
    [Show full text]
  • Software As a Service
    Software as a Service Haojie Hang Ogheneovo Dibie Executive Summary • In this presentation, we go through the Software as a Service Methodology, examine its benefits and drawbacks and talk about two state-of-art SaaS systems– Amazon Web Service and Google App Engine • We also look into Service Oriented Architecture powering SaaS applications and its impact on modern web 2.0 applications • Finally, we examine hybrids of traditional and SaaS applications Overview • What is Software as a Service (SaaS) • Background o Brief history o Concept o Big picture o Related terms • Computing Today o SasS is everywhere o The SaaS Market • Benefits of SaaS • Drawbacks of SaaS o Robustness o Privacy o Security o Reliability • Service Oriented Architectures (SOA) o Guiding principles of SOA • Case studies o Amazon Web Services (AWS) o Google App Engine • Influence of SOA on Web 2.0 development o Zend Framework • Hybrids of Traditional and SaaS applications o Dropbox o Microsoft Office • Summary • References What is SaaS? • Definition: Software as a Service (SaaS), a.k.a. on- demand software, is a software delivery model in which software and its associated data are hosted centrally and accessed using a thin-client, usually a web browser over the internet. – Wikipedia • Simply put, SaaS is a method for delivering software that provides remote access to software as a web- based service. The software service can be purchased with a monthly fee and pay as you go. What is SaaS? • Where does the term SaaS come from? o The SAAS acronym allegedly first appeared
    [Show full text]
  • Browser MMS Email OMA DL Codecs
    Solutions for OEM, ODM and Platform manufacturers Page 1 www.winwap.com Browser MMS Email OMA DL Codecs Page 2 Applications for connected consumer devices WEB Browser . 4 MMS Client . 8 Email Client . 11 OMA Download Agent . 16 Multimedia Codecs by On2 . 17 About Winwap Technologies. 18 OEM SOLUTIONS Page 3 WEB & WAP Browser Apps with open User-Interface The core functionality is built into the SDK. Keep one look and feel for your entire device Only a simple browser frame UI is required as most action takes place The Winwap MMS, Email, Browser and OMA DL solutions for most within the actual browser engine, but you platforms are dividied into SDK and User-Interface parts. The SDK is can design any UI provided in binary object code and provides the core functionality for yourself. each application. The User-Interface can optionally be provided as source code for easy integration and customization. Integrate the applications seamlessly into your device. Email Client The SDK’s support both touch and non-touch methods. Licensing are terms adjusted to fit your business model. All the complex POP and IMAP functionality as Get quick integration support from the same guys that well as folder handling has been integrated into have developed the softare. this very sofisticated SDK. The UI can as with Interoperable on a global scale thanks to over 10 years MMS be designed to look of development. any way you like and this allows you to integrate into widgets and any other part of your specific device solution to add Device integration is simple and allows to customize the value to the product.
    [Show full text]
  • Introduction to Unix
    Introduction to Unix Rob Funk <[email protected]> University Technology Services Workstation Support http://wks.uts.ohio-state.edu/ University Technology Services Course Objectives • basic background in Unix structure • knowledge of getting started • directory navigation and control • file maintenance and display commands • shells • Unix features • text processing University Technology Services Course Objectives Useful commands • working with files • system resources • printing • vi editor University Technology Services In the Introduction to UNIX document 3 • shell programming • Unix command summary tables • short Unix bibliography (also see web site) We will not, however, be covering these topics in the lecture. Numbers on slides indicate page number in book. University Technology Services History of Unix 7–8 1960s multics project (MIT, GE, AT&T) 1970s AT&T Bell Labs 1970s/80s UC Berkeley 1980s DOS imitated many Unix ideas Commercial Unix fragmentation GNU Project 1990s Linux now Unix is widespread and available from many sources, both free and commercial University Technology Services Unix Systems 7–8 SunOS/Solaris Sun Microsystems Digital Unix (Tru64) Digital/Compaq HP-UX Hewlett Packard Irix SGI UNICOS Cray NetBSD, FreeBSD UC Berkeley / the Net Linux Linus Torvalds / the Net University Technology Services Unix Philosophy • Multiuser / Multitasking • Toolbox approach • Flexibility / Freedom • Conciseness • Everything is a file • File system has places, processes have life • Designed by programmers for programmers University Technology Services
    [Show full text]
  • ASP.Net Web API
    ASP.Net Web API 1 [email protected] מה זה Web API ? Web API הוא API אותו מממש השרת והוא מחזיר לקליינט Data בלבד ולא View הבקשה והתשובה הן בפרוטוקול Http\Https הקליינטים של Web API יכולים להיות רבים : אפשר להשתמש גם בASP.Net MVC להחזיר Desktop Http\Https Application לקליינט Data אבל WEB API יותר מתאים ונוח Mobile App Server Web API Web Client Data 2 [email protected] דוגמאות ל Web API דוגמאות ידועות ל Web API : /https://jsonplaceholder.typicode.com ● https://openweathermap.org/api ● /https://developers.google.com/maps ● https://developers.facebook.com/docs/graph-api ● ● ועוד רבים 3 [email protected] ASP.Net Web API Microsoft מאפשרת לנו לכתוב שרת אשר מממש Web API כך שקליינטים יוכלו לפנות אליו ולקבל מידע התשתית שמאפשרת זאת נקראת ASP.Net Web API התשתית הזו מאוד דומה ל ASP.Net MVC ההבדל המרכזי הוא ש ASP.Net MVC יכול להחזיר View ויכול להחזיר Data ואילו ASP.Net Web API יכול להחזיר רק Data 4 [email protected] מה זה REST ? REST הוא ראשי תיבות של - Representational State Transfer REST הוא architectural pattern ליצירת API שמשתמש ב HTTP לתקשורת REST הומצא בשנת 2000 REST נמצא בשימוש רוב האתרים שחושפים WEB API 5 [email protected] דוגמא לשימוש בREST עבור אתר הבלוגים שלנו Resource HTTP method Expected output Response Code OK/200 החזרת רשימת כל הבלוגים api/blogs GET/ Created/201 יצירת בלוג חדש api/blogs POST/ No Content or 200/OK/204 עדכן מידע בלוג קיים שהid הוא api/blogs/73 PUT 73/ No Content or 200/OK/204 מחק בלוג קיים שהid הוא api/blogs/73 DELETE 73/ OK/200 החזרת מידע בלוג שהid שלו הוא api/blogs/73 GET 73/ נובע מrouting עם api טבלה בעזרתה אפשר לממש controller .CRUD בשם את המידע עובר ב PUT/POST אפשר BlogsController כאשר id לא נמצא מחזירים להעביר כ querystring שנוסף ל url או ב body של הrequest 404/Not Found 6 [email protected] שימוש ב ASP.Net Web API נוסיף ספריה api תחת ספרית Controllers של פרויקט קיים של ASP.Net MVC.
    [Show full text]