Skip to main content

Projects and apps

Overview​

After you have purchased the product on AWS Marketplace, the first step to use AutomatID is to create at least one project.

Each project is associated with:

  1. Whether the response that you receive at the end of each identification is encrypted or not. If yes, the corresponding encryption key
  2. Whether you have enabled the payment card verification functionality or not. If yes, the corresponding encryption key
  3. One or more applications
tip

Since each projects is associated with encryption keys, a best practice is to create a "development" project and a "production" project, in order to have different sets of keys for those environments.

A project can contain one or more applications.

An application is defined by:

  1. Platform: Android or iOS
  2. Nickname: a descriptive name that is only used in the administration portal to identify the app (for example in the Analytics section)
  3. Application id: the application id (Android) or bundle id (iOS) of the application

You can create as many applications as you like.

For each application, you will obtain a configuration file that you will need to embed in the application project. See Initialization for more details.

Project creation​

To create a new project, follow these steps:

  1. Login on the AutomatID Web Portal
  2. Click on Create your first project and type a project name
  3. Download the Public key that you will use to verify the authenticity of the responses that you'll receive at the end of each identification performed with AutomatID
  4. Decide whether to have the responses encrypted or not. In case you want to enable the encryption you can choose to provide a public key that you generated on your own (see Key Pair Generation), or let the AutomatID generate the keys for you and then download the private key to decrypt the response.
  5. Decide whether to enable the payment card verification functionality or not. In case you want to use this functionality you can choose to provide a private key that you generated on your own (see Key Pair Generation), or let the AutomatID Web portal generate the keys for you and then download the private key to encrypt the jwt containing the card data that needs to match the card data scanned by the user.

Key Pair Generation​

In order to generate a key pair you can use openssl in a terminal and execute the following commands:

Generate a private key:

  • command: openssl genrsa -out private.pem 4096
  • output: a private key in a file named private.pem

Derive public Key from private key:

  • command: openssl rsa -in private.pem -pubout -out public.pem
  • output: a public key in a file named public.pem

When the file requested is a private key you need to upload the private.pem, when the file requested is a public key you need to upload the public.pem.

App creation​

Once you have created a project, you are ready to create an app linked to that project. In order to create a new application you need to follow these steps:

  1. Click on Create your first app, select the platform (iOS or Android), choose a nickname and an application id
  2. Download the configuration file.
  3. Integrate the configuration file in your application project as described in Initialization.
  4. You are ready to start using AutomatID.