API

[jverbraeken]

• Parent issues: -

• Relevant issues: #17

• Estimated effort: -

• • *

User story

As a product owner I want to have an API so that others can build an application on top of a secure key exchange service

What

This issue demands an API that can be used by third-party developers to use in their application correct public keys.

Why

This issue is needed for the project because third-party application developers want to provide for their users a secure way to communicate over Bluetooth, for example by using the private/public key mechanism, and an API is needed to get the correct public keys of the user's partners without reimplementing this whole application.

How

This feature can be added by exposing the functionality needed by third-party developers in a public API

Definition of done

This task can be considered done when

• Third-party developers can retrieve public keys by using the API

Notes

[ericcornelissen]

An initial draft for the API documentation: 🎉 api documentation draft.pdf

[ericcornelissen]

This issue will be delayed due to #241