Skip to content

saeid-elio/epotheke-sdk

 
 

Repository files navigation

epotheke-SDK

The epotheke SDK is a Kotlin Multi-Platform (KMP) library implementing the client side of the CardLink protocol. It takes care of the communication with the CardLink service and the handling of the eHealth card.

A simple android demo application can be found in the demo-android-standalone folder. iOS support will follow in a successive release.

The latest documentation can be found at https://mvn.ecsec.de/repository/data-public/epotheke/sdk/doc/latest/.

App Integration

The epotheke SDK provides an API which can be integrated directly using the SdkCore class. To eliminate the need to write platform specific glue code, there are platform specific classes, which can be used instead. On Android, the SdkActivity can be extended, so only the App specific interaction handlers need to be implemented.

The epotheke SDK contains three handlers, that need to be implemented:

  • SdkErrorHandler for handling errors related to the SDK initialisation
  • CardLinkInteraction for exchanging data between the user and the CardLink service
  • CardLinkControllerCallback for providing the CardLink result and protocols for subsequent processes (e.i. Prescription retrieval/selection)

For details on how to configure your app project, refer to the manual.

epotheke SDK Interfaces

Building the SDK

Before building the SDK, it is necessary to setup the android SDK either directly or together with Android Studio. Make sure to set the ANDROID_HOME variable as explained here.

In order to build the SDK for use in an app, it can be published to the local maven repository with the following command:

./gradlew publishToMavenLocal

After successful execution of the command, the SDK can be used as shown in the demo application. The version of the SDK is defined in the gradle.properties file.

License

The epotheke SDK uses a Dual Licensing model. The software is always distributed under the GNU General Public License v3 (GPLv3). Additionally, the software can be licensed in an individual agreement between the licenser and the licensee.

About

epotheke Software Development Kit (SDK)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 92.1%
  • TypeScript 4.7%
  • Objective-C 1.3%
  • Ruby 0.8%
  • Objective-C++ 0.4%
  • JavaScript 0.4%
  • Swift 0.3%