Will be updated based on the discussions with client organisations.
Building the integration to Suomi.fi Messages
The Suomi.fi Messages domain model is based on the organisations and services under the organisation. However, to integrate to Suomi.fi Messages there is need to have a technical domain element, which is referred to as a system. The image below clarifies the domain elements. A system can have one to many services and organisations can have one to many systems.
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkVYVCBSYW50YW5lbiBKdWhhIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IkVYVCBIaWV0YWxhIEhpbHBwYSIsImxhbmd1YWdlIjoiZW4iLCJkaWFncmFtRGlzcGxheU5hbWUiOiIiLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiIyODcxMzEzNTUiLCJkaWFncmFtTmFtZSI6ImludGVncmF0aW9uIiwiYXNwZWN0IjoiIiwibGlua3MiOiJhdXRvIiwiY2VvTmFtZSI6IlRlY2huaWNhbCBkb2N1bWVudGF0aW9uIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjoyODcxMjE4NDksImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjI4NzEyMTg0OSwicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6MywibWFjcm9JZCI6Ijc0ODk2NjAxLTdkMmMtNDY4YS05ZDU2LTAxOTMxODJhNjBiYSIsInByZXZpZXdOYW1lIjoiaW50ZWdyYXRpb24ucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjQyMSIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTcwODkzMjQyMTUxOSwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
Picture 1: Domain model
REST-API
We have planned one major change to REST compared to previous integrations. In the initial plans we have decided to build REST to be one-directional meaning that all the calls will be done from organisations' systems to Suomi.fi Messages REST-APIs, as can be seen from the picture below. There will be APIs to at least
- Add files/attachments
- Send messages
- Get message states
- Get changes to sent messages and new messages sent by end users to the organisation.
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkVYVCBSYW50YW5lbiBKdWhhIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IkVYVCBSYW50YW5lbiBKdWhhIiwibGFuZ3VhZ2UiOiJlbiIsImRpYWdyYW1EaXNwbGF5TmFtZSI6IiIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjI4NzEzMTQ2MyIsImRpYWdyYW1OYW1lIjoicmVzdC1hcGktZW5kcG9pbnRzIiwiYXNwZWN0IjoiIiwibGlua3MiOiJhdXRvIiwiY2VvTmFtZSI6IlRlY2huaWNhbCBkb2N1bWVudGF0aW9uIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjoyODcxMjE4NDksImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjI4NzEyMTg0OSwicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6NywibWFjcm9JZCI6IjUwZjgyYzdjLWIzNDktNGY0Zi05ODgyLWFkYjc2ZTIxNjc1MyIsInByZXZpZXdOYW1lIjoicmVzdC1hcGktZW5kcG9pbnRzLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiI2MzEiLCJzaW1wbGVWaWV3ZXIiOmZhbHNlLCJsYXN0TW9kaWZpZWQiOjE3MDkzMDMwMzAxMjcsImV4Y2VlZFBhZ2VXaWR0aCI6ZmFsc2UsIm9DbGllbnRJZCI6IiJ9
Picture 2: Initial draft of the endpoints
