This document defines the framework, function and protocols for an API ecosystem that will enable online synchronised interaction. Specifically, the document:<\/p>\n
defines a logical and technical layered approach for developing APIs, including transformational rules. Specific logical models (such as ISO 20022 models) are not included, but they will be referenced in the context of specific scenarios for guidance purposes;<\/p>\n<\/li>\n
will primarily be thought about from a RESTful design point of view, but will consider alternative architectural styles (such as WebSocket and Webhook) where other blueprints or scenarios are offered;<\/p>\n<\/li>\n
defines for the API ecosystem design principles of an API, rules of a Web-service-based API, the data payload and version control;<\/p>\n<\/li>\n
sets out considerations relevant to security, identity and registration of an API ecosystem. Specific technical solutions will not be defined, but they will be referenced in the context of specific scenarios for guidance purposes;<\/p>\n<\/li>\n
defines architectural usage beyond query\/response asynchronous messaging towards publish\/subscribe to support advanced and existing business models.<\/p>\n<\/li>\n<\/ul>\n
This document does not include:<\/p>\n
a specific technical specification of an API implementation in financial services;<\/p>\n<\/li>\n
the development of JSON APIs based on the ISO 20022 specific message formats, such as PAIN, CAMT and PACS;<\/p>\n<\/li>\n
a technical specification that is defined or determined by specific legal frameworks.<\/p>\n<\/li>\n<\/ul>\n
| PDF Pages<\/th>\n | PDF Title<\/th>\n<\/tr>\n | ||||||
|---|---|---|---|---|---|---|---|
| 2<\/td>\n | National foreword <\/td>\n<\/tr>\n | ||||||
| 7<\/td>\n | Foreword <\/td>\n<\/tr>\n | ||||||
| 8<\/td>\n | Introduction <\/td>\n<\/tr>\n | ||||||
| 9<\/td>\n | 1 Scope 2 Normative references 3 Terms and definitions <\/td>\n<\/tr>\n | ||||||
| 11<\/td>\n | 4 Design principles 4.1 General 4.2 Standards compatibility 4.3 Extensibility 4.4 Non-repudiation 4.5 Web resource unique identifiers (ID fields) 4.6 Idempotency 4.7 States 5 Related technology 5.1 General 5.2 Representational state transfer (REST) and simple object access protocol (SOAP) 5.2.1 General <\/td>\n<\/tr>\n | ||||||
| 12<\/td>\n | 5.2.2 REST 5.2.3 SOAP <\/td>\n<\/tr>\n | ||||||
| 13<\/td>\n | 5.3 WebSocket and Webhook 5.3.1 General 5.3.2 WebSocket 5.3.3 Webhook <\/td>\n<\/tr>\n | ||||||
| 14<\/td>\n | 5.4 HTTPS 5.5 JSON and XML 5.5.1 General 5.5.2 JSON 5.5.3 XML <\/td>\n<\/tr>\n | ||||||
| 15<\/td>\n | 5.6 Content negotiation 5.7 RESTful API description languages 6 Naming conventions <\/td>\n<\/tr>\n | ||||||
| 16<\/td>\n | 7 Resource path 7.1 General 7.2 Resource hops <\/td>\n<\/tr>\n | ||||||
| 17<\/td>\n | 7.3 Single resource versus collections of resources 8 WAPI styles 8.1 General <\/td>\n<\/tr>\n | ||||||
| 18<\/td>\n | 8.2 REST 8.2.1 General <\/td>\n<\/tr>\n | ||||||
| 19<\/td>\n | 8.2.2 Uniform interface <\/td>\n<\/tr>\n | ||||||
| 20<\/td>\n | 8.2.3 Apply the standard HTTP methods <\/td>\n<\/tr>\n | ||||||
| 21<\/td>\n | 8.2.4 Stateless sessions 8.2.5 Idempotency 8.2.6 Composition of the URI <\/td>\n<\/tr>\n | ||||||
| 22<\/td>\n | 8.2.7 Handling associations between resources 8.2.8 Request parameter usage <\/td>\n<\/tr>\n | ||||||
| 25<\/td>\n | 8.2.9 Post usage <\/td>\n<\/tr>\n | ||||||
| 26<\/td>\n | 8.2.10 The response <\/td>\n<\/tr>\n | ||||||
| 29<\/td>\n | 8.3 Asynchronous messaging and server push <\/td>\n<\/tr>\n | ||||||
| 30<\/td>\n | 8.3.1 Bidirectional communication model <\/td>\n<\/tr>\n | ||||||
| 31<\/td>\n | 8.3.2 Message subscription <\/td>\n<\/tr>\n | ||||||
| 32<\/td>\n | 8.3.3 Message publish 9 Data payload syntax 9.1 JSON 9.1.1 General 9.1.2 Syntax and structure <\/td>\n<\/tr>\n | ||||||
| 34<\/td>\n | 9.1.3 Data types 9.2 XML 9.2.1 General 9.2.2 Syntax and structure <\/td>\n<\/tr>\n | ||||||
| 36<\/td>\n | 9.2.3 Data types <\/td>\n<\/tr>\n | ||||||
| 38<\/td>\n | 10 Security and authentication 10.1 General 10.2 TLS <\/td>\n<\/tr>\n | ||||||
| 39<\/td>\n | 10.2.1 Certificate issuance and verification 10.3 Application and access layer security 10.3.1 Introduction <\/td>\n<\/tr>\n | ||||||
| 40<\/td>\n | 10.3.2 Overview of the OAuth 2.0 protocol <\/td>\n<\/tr>\n | ||||||
| 41<\/td>\n | 10.4 Read-only security profile 10.5 Read and write security profile 10.6 Message level integrity, source authentication and non-repudiation 10.6.1 General <\/td>\n<\/tr>\n | ||||||
| 42<\/td>\n | 10.6.2 Signing HTTP requests and responses 10.6.3 Signing JSON Payload <\/td>\n<\/tr>\n | ||||||
| 43<\/td>\n | 10.6.4 HTTP signature 10.7 Message level encryption 10.8 Version control <\/td>\n<\/tr>\n | ||||||
| 44<\/td>\n | 11 Use cases 11.1 ISO 20022 Web services 11.1.1 Introduction 11.1.2 Modelling guidelines <\/td>\n<\/tr>\n | ||||||
| 46<\/td>\n | 11.2 Mapping rules 11.2.1 RepositoryConcept <\/td>\n<\/tr>\n | ||||||
| 47<\/td>\n | 11.2.2 MessageDefinition 11.2.3 MessageBuildingBlock <\/td>\n<\/tr>\n | ||||||
| 48<\/td>\n | 11.2.4 MessageComponent 11.2.5 ChoiceComponent <\/td>\n<\/tr>\n | ||||||
| 50<\/td>\n | 11.2.6 MessageElement <\/td>\n<\/tr>\n | ||||||
| 51<\/td>\n | 11.2.7 ISO 20022 DataType transformation to JSON Schema <\/td>\n<\/tr>\n | ||||||
| 57<\/td>\n | Annex A (informative) Approach to FX trading <\/td>\n<\/tr>\n | ||||||
| 60<\/td>\n | Bibliography <\/td>\n<\/tr>\n<\/table>\n","protected":false},"excerpt":{"rendered":" Web-service-based application programming interface (WAPI) in financial services<\/b><\/p>\n |