{"id":834,"date":"2024-11-12T15:19:19","date_gmt":"2024-11-12T14:19:19","guid":{"rendered":"https:\/\/tomp-wg.org\/?p=834"},"modified":"2024-11-12T16:29:13","modified_gmt":"2024-11-12T15:29:13","slug":"a-fair-tomp-api","status":"publish","type":"post","link":"https:\/\/tomp-wg.org\/?p=834","title":{"rendered":"A FAIR TOMP-API"},"content":{"rendered":"\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t

TOMP-API & FAIR principles<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

<\/p>\n

The TOMP-Working group is on a mission to develop and sustain an open standard for technical communication between Transport Operators and MaaS Providers. To fulfil this mission, ‘alignment’ and ‘interoperability’ are crucial. Both words are often used in one sentence with the acronym \u2018FAIR\u2019. This stands for F<\/b>indable, A<\/b>ccessible, I<\/b>nteroperable and R<\/b>eusable.<\/p>\n

<\/p>\n

<\/p>\n

<\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t

\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t\"Image:\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

The FAIR-principles saw the light in a 2016-article in<\/span> the journal <\/span>Scientific Data <\/span>(a part of <\/span>Nature<\/i><\/span>). The<\/span> \u2018FAIR Guiding Principles for scientific data management and stewardship\u2019 <\/span>aim to optimise the reuse of research data by making them Findable, Accessible, Interoperable and Reusable, for humans but also for machines.\u00a0<\/span><\/p>\n

Now, what is the impact of these principles on the TOMP-API, and how do we apply them?<\/span><\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t

\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t

Findable<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

\u2018Findable\u2019 means that the data should be easy to find. T<\/span>his is not the TOMP’s responsibility (as it is only a specification), but we are prepared to be found and explored. For example, a part of the \u2018Operator Information Module\u2019 describes what is implemented in the API – note that in most cases, the TOMP is implemented partially, only implementing the needed use cases from a business perspective. On top of this, we describe how the API works, and what can be expected. In version 2.0 we will even formalise the allowed \u2018next steps\u2019, namely the flow throughout the interface. Each response describes what can be done and the possible next steps (=requests).<\/span><\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t

\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t

Accessible<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

\u2018Accessible\u2019 means that the user needs to know how the data can be accessed. <\/span>The interface should be technically accessible. Therefore we do not limit the identification nor the authentication methods. Whether you want to set up a secure method, like certificates, OAuth2, JWT, or less secure ones like username\/password, we do not restrict. The API can be implemented in any environment, the technical accessibility is a bilateral agreement between the Maas Provider and the Transport Operator(s). This is required because there are implementations globally and security rules are not equally important everywhere.\u00a0<\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t

\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t

Interoperable<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

‘Interoperable’ means that the data can be used in other operations (inter-operations), which implies that you should have a clear definition of all your concepts.\u00a0That is why we want to make sure that we support the exchange of data between MaaS Providers and Transport Operators by developing an open standard they can rely on.<\/span><\/p>\n

It is also one of the reasons why we have decided to revise entirely the architecture of the TOMP-API in its upcoming version. This will allow the TOMP-API to be used with Transmodel-based standards such as NeTEx. In that sense, the TOMP-WG is actively contributing to data being interoperable for all.<\/span><\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t

\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t

Reusable<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

Last but not least, the FAIR principles aspire to optimise the reuse of data. To allow reuse,\u00a0these data should be well-described.\u00a0<\/span>And that makes this principle the toughest of the four. We noticed that sharing data is already a sensitive operation. In the beginning, when we used GBFS as a starting point for the \u2018support trip planning\u2019 part (the Operator Information Module) and modified it to serve our use needs, we found out that it directly conflicts with existing GBFS imports from Journey Planners. The goal of the latter is different, even different enough to make it unusable for our case. In other words, being ‘reusable’ comes with a high price: you create datasets that serve multiple goals, with all costs related.<\/span><\/p>\n

With the anticipated version 2.0, we have the ambition to remove overlap with existing standards, so the principle of reusability will be respected after all. We want to remove parts that overlap and work together with the organisations of the existing standards, proposing extensions or modifications to these standards, to serve as the original goal (like trip planning), but also supply the required data to start booking using the TOMP-API. Now that is real alignment!<\/span><\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t

\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t

In conclusion...<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t

As was illustrated above, the TOMP-API takes the FAIR principles seriously. Not only do we take them into account, we also comply with the principles wherever we can and provide a solid base to be used everywhere, for instance in bilateral usages and European data spaces, but also as a standard for new Transport Operators.<\/span><\/span><\/p>\n

\u00a0<\/span><\/span><\/p>\n

Author<\/u>: Edwin van den Belt<\/a><\/i><\/p>\n

Edits<\/u>: Tu-Tho Thai<\/a>, Jelten Baguet<\/a><\/i><\/p>\n

\u00a0<\/span><\/span><\/p>\n

Interested in further reading? Have a look at the original publication of the FAIR principles in Science Data<\/a> or read the introduction on the Go-FAIR website<\/a>.<\/span><\/span><\/p>\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"

The TOMP-Working Group is on a mission to develop an API that is \u2018FAIR’: Findable, Accessible, Interoperable and Reusable.<\/p>\n

Read more about this ambition in the blog written by Edwin van den Belt.<\/p>\n","protected":false},"author":2,"featured_media":839,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[67],"tags":[68,62,8,47],"jetpack_featured_media_url":"https:\/\/tomp-wg.org\/wp-content\/uploads\/2024\/07\/FAIRdataprinciples_foster.png","_links":{"self":[{"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/posts\/834"}],"collection":[{"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=834"}],"version-history":[{"count":61,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/posts\/834\/revisions"}],"predecessor-version":[{"id":1026,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/posts\/834\/revisions\/1026"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=\/wp\/v2\/media\/839"}],"wp:attachment":[{"href":"https:\/\/tomp-wg.org\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=834"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=834"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/tomp-wg.org\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=834"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}