yoti-sdk-spring-boot-auto-config

Yoti Spring Boot Auto Configuration Java SDK Module

This module aims to make integration of the Yoti SDK client into Spring Boot projects more simple by reducing the amount of boilerplate code required by the client application and allows the developer to simply provide two properties.

Requirements

• Spring Boot
• Java 7 or newer

Usage

Add Dependencies

If you are using Maven, you need to add the following dependencies:

<dependency>
  <groupId>com.yoti</groupId>
  <artifactId>yoti-sdk-spring-boot-auto-config</artifactId>
  <version>3.10.0</version>
</dependency>

If you are using Gradle, here is the dependency to add:

compile group: 'com.yoti', name: 'yoti-sdk-spring-boot-auto-config', version: '3.10.0'

Configure The Client

The client supports configuration via Spring property sources such as YAML or properties files.

The accessSecurityKey property supports any of the default Spring resource loader strings. See here for more details.

Examples include:

• com.yoti.client.accessSecurityKey=classpath:/my-key.pem
• com.yoti.client.accessSecurityKey=file:/my-key.pem

Remember it is your responsibility to keep your secret key safe! You may wish to think carefully about where you place the PEM file and whether it should be included in your distribution or committed into SCM. If storing it on a filesystem you should be mindful of the file ownership and permissions.

Application Properties

com.yoti.client.clientSdkId=my-app-id
com.yoti.client.accessSecurityKey=file:~/.yoti/my-key.pem

YAML

com:
    yoti:
        client:
            applicationId: "my-application-id"
            clientSdkId: "my-client-sdk-id"
            accessSecurityKey: "file:/my-key.pem"

That's It - You're Done!

Expecting more? That's all that you need to integrate Yoti into your Spring Boot application.

Authors

• David Goaté