Personal Details
Overview
Vendors
User Experience
The following section describes information relating to the user experience for the Personal Details product integration.
User Activities
Authentication
The connection to the vendor is handled as part of the generic API Configuration under the Vendor section. The first part of the API Configuration details the URL to which to connect and any parameters that are required. The second part relates to the API Authentication for the URL, which is vendor specific, and could also be specific to the vendor instance the client is running.
Offline Support
Data is stored on the user’s device for offline viewing.
Screenshots
Technical Overview
The following section describes technical information for the Personal Details product integration.
Prerequisites
In order to retrieve the data, you need to create an API with the following requirements:
- The API is in the format: https://www.mydomain.com/getUserDetails.
- The API receives as a query parameter a user parameter that receives the user's identifier as configured in the API configuration. For example: https://www.mydomain.com/getUserDetails?user=username
- The API returns a JSON response with the following structure:
To display an image, it must be returned in the API under the key photo.
For example: https://www.mydomain.com/getUserDetails?user=username
Configuration
Configuration Option | Description | Mandatory | Data Type | Default | Example |
---|---|---|---|---|---|
Manage Integration | |||||
Enable Product Integration | Select to enable the product integration on the user's campusM app. | No | Checkbox | Unselected | |
Product Integration Description | A description of the product integration for internal use | Yes | String | ||
Screen Title | The title that appears in the top header of the service | No | String | Registration Status | |
Vendor – This section defines the structure of the APIs used in this product integration. | |||||
Vendor Name | Defines to which vendor the integration connects. | Yes | Drop-down list | API | |
API Configuration This section contains the API details to define the API structure. You can test the API configuration. See Testing API Product Integration Configuration. |
|||||
Base URL to retrieve the information | The URL for the API | Yes | URL | https://{HOST} | |
Parameter Input Option | The parameter input option. Possible values: Username, Token Property, and Constant. It is sent as the path parameter | . | Yes | Drop-Down list | Token Property |
Token Property Name | Enter the property name to be retrieved from the token ({ USERNAME, MAIL, GIVEN_NAME, SURNAME, FULL_NAME } or as named in the integration profile) | No | String | USERNAME | |
Constant Value | The value when the User Identifier is set to Constant | No | String | ||
Authentication Type | Authentication type against the web service. The options are the following:
|
No | Object | No Auth | |
General | |||||
Enable Picture | Select to display a picture of the user | No | Boolean | False | |
Fields | The fields to be displayed on the page | No | Array | ||
Code | The key this field returns in the API response | Yes | String | name | |
Label | The label to display on the page | Yes | String | Name | |
Look and Feel | |||||
Primary Theme Color | Select a color for the main elements on the page | No | Color Picker | #444444 | |
Secondary Theme Color | Select a color for the secondary elements on the page | No | Color Picker | #6f8ea4 | |
Text/Labels | |||||
Page Title | Shown at the top of the page. To not display a page title please enter 'noHeader'. | No | String | Personal Details | |
Error Message | The text to be displayed when there is an error reaching the API | No | String |
There was an error retrieving the data |
|
Import/ Export Configuration You can configure product integration and then export it to another campusM environment, for example, from sandbox to production or from preview to production. |
|||||
Export | Create a JSON file with all product integration configuration. | No | |||
Import | Use this option in order to load configuration from JSON of an exported product integration. | No |