Get Started

iOS

Min requirements

  • iOS 10

  • XCode 9 or higher

  • Swift 3.2

  • iPhone 5 device or higher, iPad 4th gen or higher, iPad mini 2nd gen or higher

  • Registered Apple developer account

Prerequisites

  • AppID

  • ContractIDs (2)

  • .p12 private key (2)

  • Financial CSV export (optional)

  • Dropbox credentials (optional)

  • digi.me library password (optional)

  • digi.me Helium for Windows (optional for CSV import)

Quick Start Guide

  1. Download the digi.me app from iTunes

  2. Open the digi.me client app,

  3. If you have Dropbox details tap on 'I already have a library' and enter the Dropbox credentials and library password then go to step (5), else go to step (4)

  4. If you don't have Dropbox details;

    1. Tap on 'Create a library' to start building a new library to use

    2. Tap on Dropbox and enter your credentials - this authorises the digi.me app to create an accessible folder on Dropbox where we can store and access files for your data

    3. Tap on the services you require to add them to your digi.me library.

  5. Clone SDK repository from GitHub

  6. Open the Example folder and open the DigimeFramework workspace file.

  7. Change the bundle identifier to a unique value com.[yourname].[appname]

  8. Replace the kContractIDs in Constants.swift with your contract IDs

  9. Add your AppID to Constants.swift in kAppID such as "myteam"

  10. Replace the AppID in info.pList > URL types > URL Schemes > Item 0 as "digime-ca-[AppID]" such as "digime-ca-myteam"

  11. Copy CA_RSA_PRIVATE_KEY1.p12 & CA_RSA_PRIVATE_KEY2.p12 into the "Example for DigiMeFramework" folder. This should replace the file already there. If it does not, just remove all the files and copy them in again. Please be sure to add these files to target "DigiMeFramework_Example". If you are having decryption issues, you most likely forgot to check the box.

  12. Open, build, then run the project on your device. If you have issues building the project, you most likely have to select a valid Team under the code signing section of the project. You will probably have to do this for both targets: DigiMeFramework_Example and DigiMeFramework_Tests.

For further information please see the README.md file

Android

Min Requirements

  • JDK above 1.8.144

  • Android Studio 2.3.3

  • Development to support Android API 21 or higher - >= Android 5.0.2 (LOLLIPOP)

Prerequisites

  • AppID

  • ContractIDs

  • .p12 private key

  • Financial CSV export (optional)

  • Dropbox credentials (optional)

  • digi.me library password (optional)

  • digi.me Helium for Windows (optional for CSV import)

Quick Start Guide

  1. Download the digi.me app from Google Play

  2. Open the digi.me client app,

  3. If you have Dropbox details tap on 'I already have a library' and enter the Dropbox credentials and library password then go to step (5), else go to step (4)

  4. If you don't have Dropbox details;

    1. Tap on 'Create a library' to start building a new library to use

    2. Tap on Dropbox and enter your credentials - this authorises the digi.me app to create an accessible folder on Dropbox where we can store and access files for your data

    3. Tap on the services you require to add them to your digi.me library.

  5. Clone SDK repository from GitHub 

  6. Inside the cloned repository, navigate to consent-access-no-sdk and rename sdkconfig.properties.default to sdkconfig.properties

  7. Open the digime-android-sdk in Android Studio

  8. Navigate to `consent-access` sample project within Android Studio

  9. Ensure that Android Studio is using the correct JDK Version. Navigate to settings; File > Project Structure > SDK Location. Disable "use embedded JDK (recommended)". Click into text box to select the JDK location.

    1. Download and install the JDK from Oracle

    2. For MacOS the JDK is typically here: /Library/Java/JavaVirtualMachines/jdk1.8.0_144.jdk/Contents/Home

    3. For Windows: the JDK is typically here: C:\Program Files\Java\jdk1.8.0_144

  10. Add your contractId to sdkconfig.properties at digimeConsentAccessContractId

  11. Add your appid to src/main/AndroidManifest.xml as the value for me.digi.sdk.AppId. Replacing value of `DIGIME_APP_ID` constant with your appid

  12. Add the p12 file in src/main/assets

  13. Add the p12 key relative path to sdkconfig.properties at digimeConsentAccessP12KeystoreSelect

  14. Select `consent-access` application from the “Select Run/Debug configurations” dropdown button

  15. Build the project

  16. See the README.md for more detailed information