MISO MUI 2.0 API User Guide
1
Table of Contents
About This Document......................................................................................................................................... 3
Purpose of This Document ...................................................................................................................................................................... 3
Scope of This Document .......................................................................................................................................................................... 3
Related Documents ................................................................................................................................................................................... 4
1. Introduction ...................................................................................................................................................... 4
User Authentication ..................................................................................................................................4
Technology Prerequisite Knowledge ........................................................................................................................................... 5
Test Tools ....................................................................................................................................................5
External Interface Data Exchange Overview ........................................................................................................................... 5
Data Exchange Synopsis ................................................................................................................................................................... 6
OpenAPI / Swagger Editor ............................................................................................................................................................... 7
2. Introduction to the API .................................................................................................................................. 8
Messaging Overview.......................................................................................................................................................................... 8
The Role of the End User ........................................................................................................................8
The Role of MISO ....................................................................................................................................8
The Role of the MP..................................................................................................................................9
Required Capabilities ........................................................................................................................................................................ 9
Authentication ..................................................................................................................................................................................... 9
HTTP/HTTPS and TLS ....................................................................................................................................................................... 9
Security Best Practices .................................................................................................................................................................. 10
Session Management ............................................................................................................................10
Check for MISO Public Key ..................................................................................................................10
IP Whitelisting Notifications Connections .........................................................................................10
Rate Limits .......................................................................................................................................................................................... 11
Historical Data Availability ........................................................................................................................................................... 11
Using JSON ......................................................................................................................................................................................... 11
Notifications....................................................................................................................................................................................... 12
Notifications – Registering URL and Sending Test Messages ..........................................................13
3. Common Principles ...................................................................................................................................... 13
Participant Registration ................................................................................................................................................................ 13
OpenAPI Specification Schema................................................................................................................................................... 14
HTTP Methods .................................................................................................................................................................................. 15