Eye On Id

Change Log

22th October 2024

Jonas Falk Nielsen

1.0

Doc created.

Introduction

The rator-identity-theft-protection-no-eyeonid module is a client integration towards the Square trade insurance using jersey for its REST client implementation.

Include the maven artifact in the pom.xml of parent projects to use the functionality.

Maven Artifact

<dependency>  

<groupId>com.cdrator.integration.identity-theft-protection</groupId>
<artifactId>rator-identity-theft-protection-no-eyeonid</artifactId>
<version>1.0-SNAPSHOT</version>

</dependency>

The following dependencies are also needed at runtime, if not already included in the client project, as they are provided scope in the integration module and thus does not get transitively added to a build:

com.cdrator.integration.utils.rator-utils-restutils
com.cdrator.core:rator-engine-api
com.cdrator.util.rator-logging
com.cdrator.workflow.hookpoint-stats
com.cdrator.workflow.hookpoint-documentation
org.glassfish.jersey.media:jersey-media-json-jackson

Source code for the module can be found in bitbucket: https://bitbucket.org/enghouseglobal/nw-ra-rator-identity-theft-protection-no-eyeonid

 

Square Trade API Documentation

The API is documented here: https://apidocs.eyeonid.com

Note that we currently don’t have a CDRator login, only a logic shared by a customer.

Implementation

The project consist of a few simple calls, it is dependent on the Generic order engine to handle the data needed.

Configuration

Parameters

The parameters needed for connecting to EyeOnId are configured in the parameter tree under the node IDENTITY_THEFT_PROTECTION.EYE_ON_ID.

The following parameters are used in the rator-identity-theft-protection-no-eyeonid module.

IDENTITY_THEFT_PROTECTION.EYE_ON_ID

IDENTITY_THEFT_PROTECTION.EYE_ON_ID

NAME

EXAMPLE VALUE

MANDATORY

DESCRIPTION

NAME

EXAMPLE VALUE

MANDATORY

DESCRIPTION

BASE_URL

None

Yes

The base endpoint for the Eye on Id system

CLIENT_ID

N074R341V41u38u7C10533n0u9hR19h7

Yes

The value to use for the client_id part of the client_id:client_secret credentials that must be Base64-encoded and can then be used to call endpoint oauth/v2/token; see also parameter CLIENT_SECRET.

CLIENT_SECRET

4n07h3rF4k3V41u3

Yes

The value to use for the client_secret part of the client_id:client_secret credentials that must be Base64-encoded and can then be used to call endpoint oauth/v2/token; see also parameter CLIENT_ID.

TOKEN

 

No

If branded USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET parameters are used, this parameter has to be created manually.

The currently valid token for authorization.

This will be automatically populated if there is only one set of credentials used. If multiple sets of credentials (USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET) are used via branding of parameters, in combination with a set of non-branded/default credentials, this parameter has to be created beforehand, so as not to interfere with the non-branded/default one.

TOKEN_EXPIRY

 

No

If branded USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET parameters are used, this parameter has to be created manually.

The point in time at which the current token will expire.

This will be automatically populated if there is only one set of credentials used. If multiple sets of credentials (USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET) are used via branding of parameters, in combination with a set of non-branded/default credentials, this parameter has to be created beforehand, so as not to interfere with the non-branded/default one.

Logging

Logging of the connection is done in the CLIENT_LOG table with the client name SQUARE_TRADE and either the inquiry or generic order id.

Examples of the exact payloads can be seen in the attached documentation.