Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    ID Card

    Overview

    The ID Card product integration allows students to present their university ID card from a mobile device. The required data can be retrieved with a RESTful API or from the IdP Details. The barcode can be generated by the app (currently, only the Codabar schema is implemented) or provided by the vendor.

    User Experience

    The following section describes information relating to the user experience for the ID Card product integration.

    User Activities

    Students can present their university ID card from a mobile device, which includes information, such as: picture, student ID, name, department, barcode, username, name, and email.

    User Workflow

    The user selects the ID Card tile to display the university ID card page.

    Authentication

    There is no need for additional user authentication besides the API authentication.

    Offline Support

    No offline support is provided. User must be online to see ID Card info.

    Screenshots

    The following is an example of the ID Card page:

    id_card.png

    ID Card

    Technical Overview

    The following section describes technical information for the ID Card product integration.

    Prerequisites

    The following prerequisities are required for the ID Card product integration.

    • For the RESTful API vendor:
      • User ID
        • ID card data should be sent based on the userID from IDP so campusM userID must be mapped in the customer’s system.
        • The CMAuth userID (which is returned by a response from either SAML, OAuth or LDAP as one of the IDP attributes) must be mapped in the CMAuth integration profile (‘Additional Mappings’). Otherwise, userID must be returned by a response as one of the LDAP attributes.
        • This attribute needs to be added as a path or query parameter.
        • The parameter can be named userID or any other name.
      • API info
        • Required Format – JSON
        • Request
          https://{HOST}/UserApi/api/users/getIDcard?userid={userID}
        • Response examples:
          • The following is an example of a valid response if the barcode is provided by the API:

            {

            "pageTitle": "Testing Header",
            "studentID": "345678901",
            "name": "Jane Doe",
            "picture": "https://...exampleImage.png",
            "department": "Computer Science",
            "status": "Full-Time Undergraduate",
            "valid_until": "31-Dec-2023",
            "barcode": "https://...exampleBarcode.png"

            }

          • The following is an example of a valid response if the barcode is generated by the App

            {

            "pageTitle": "Testing Header",
            "studentID": "345678901",
            "name": "Jane Doe",
            "picture": "https://...exampleImage.png",
            "department": "Computer Science",
            "status": "Full-Time Undergraduate",
            "valid_until": "31-Dec-2023"

            }

          • The page title can be any information the user would like to present at the top of the page (for example, static text, user name, user ID). 
          • If the response is empty, the user gets error message: Unable to reach the service at this time. Please try again later.
          • If one of the requested fields returns empty, it is either not displayed or displayed empty (for example Dept: ), depending on the configuration (see ID Cards > Display Empty Fields options).
      Attributes Mapping
      External Field Name Internal CampusM Field Name Description Mandatory Yes/No Data Type Default Example
      Picture picture Picture of the user No  String   https://...exampleImage.png
      ID Number studentID Student ID number (if you configure the app to generate the barcode, ID number is required, and this must be a valid input for Codabar) Yes, if the app is generating the barcode string   12345678
      Page Title pageTitle Information to be presented at the head of the page No string   Student ID Card
      All of the Basic Fields are configurable for the RESTful API vendor. For example, if your API returns a field called idNumber, you can configure the ID Number field to use this code instead of the default studentID code. Make sure that the fields you defined in the App Manager are mapped in your API response.
    • For the IdP Details vendor:

      The token based authentication attributes must be mapped in the Integration Profile (Username Mapping, Mail Mapping, First Name Mapping, Last Name Mapping, and Additional Mappings). For more information, see Configuring Integration Profiles.

      The IdP Details vendor uses the same Basic Fields as the RESTful API, and it automatically tries to grab the username, email, and name. The attributes from the Additional Mappings section of the Integration Profile, can be mapped in the Custom Fields section.

    Configuration

    To configure the GET ID Card product integration, select Add Product Integration from the Product Integrations main menu option.
    Select ID Card and the configuration page appears. The following table describes the configuration options available on this page.
    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 ID Card  
    Vendor
    Vendor Name Defines to which vendor the integration connects. The ID Card product integration is currently supported by the RESTful API  and IdP Details vendors. Yes Drop-down list   RESTful API
    RESTful API Configuration
    This section contains the RESTful API details  to define the API structure. You can test the API configuration. See Testing API Product Integration Configuration.
    URL to retrieve the information The URL for the Web service Yes URL    
    URL Query Parameters The parameters sent as part of the query No String   For https://someHostName/serviceName?username={user}, the query parameter is username.    
    URL Path Parameters The parameters sent as part of the path     No String   For https://someHostName/serviceName/username, the path parameter is username.    
    General Headers Add (key, value) for additional needed headers No String    
    Authentication Type Authentication type against the web service. The options are the following:
    • No Auth
    • Basic - username and password for Base64 basic authentication.
    • API Key - can be added to a Header or to the URL (Query Param) or both.
    • Bearer token
    • OAuth Using User App Authentication – select an OAuth integration profile (from the Integration Profiles configured in App Settings) and choose where the access token should be added, Header or URL.
    • OAUTH Using Client Credentials – select this if you are using a preliminary token call to get the access token.
    Yes Drop-down list    
    General
    Link to Logo it is possible to provide the link from customer’s server or import file from the customer’s asset. No URL    
    Barcode Source Select the barcode source. Two options are available:
    • Generate by app
    • Get by API – the Barcode Scheme field appears
    Yes Drop-down list    
    Barcode Scheme Select the barcode scheme for generating the barcode Yes Drop-down list Codabar  
    Code The code of the field in the API No String barcode  
    Basic Fields
    Display empty fields Indicate if you want the field to be displayed when the API returns an empty string. The options are:
    • Do not display – the fields are not displayed
    • Display empty – the fields are displayed with no value
    • Customize per field – determine per field if you want empty fields to be displayed
    Yes Drop-down list Do not display  
    Display empty fields Indicate if you want the field to be displayed when the API returns an empty string. The options are:
    • Do not display – the fields are not displayed
    • Display empty – the fields are displayed with no value
    • Customize per field – determine per field if you want empty fields to be displayed
    Yes Drop-down list Do not display  
    Picture - Code The code of the field in the API No String picture  
    Picture - Display The option to display or hide this field No Checkbox Yes  
    ID Number - Code The code of the field in the API Yes, if the app is generating the barcode  String  studentID  
    ID Number - Label The label for the student ID number
    Centering an image reduces the maximum number of characters that can be displayed in the label.
    No String ID no.  
    ID Number - Display Select if you want to display the student ID number No Checkbox    
    Page Title - Code The code of the field in the API No String pageTitle  
    Page Title - Display The option to display or hide this field No Checkbox Yes  
    Username - Label (only for IdP Details vendor) The label for the field
    Centering an image reduces the maximum number of characters that can be displayed in the label.
    No String Username  
    Username - Display (only for IdP Details vendor) The option to display or hide this field No Checkbox Yes  
    Email - Label (only for IdP Details vendor) The label for the field
    Centering an image reduces the maximum number of characters that can be displayed in the label.
    No String Email  
    Email - Display (only for IdP Details vendor) The option to display or hide this field No Checkbox Yes  
    Name - Label (only for IdP Details vendor) The label for the field
    Centering an image reduces the maximum number of characters that can be displayed in the label.
    No String Name  
    Name - Display (only for IdP Details vendor) The option to display or hide this field No Checkbox Yes  
    Custom Fields Add all custom fields to be displayed except Picture and ID Number
    Code The code of the field in the API Yes String    
    Label The label of the field
    Centering an image reduces the maximum number of characters that can be displayed in the label.
    Yes String    
    Display if Empty Select if you want to display the custom field if the field is empty No Checkbox    
    Look and Feel No      
    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  
    Background Color Select a color for the background of the page No Color Picker  #ffffff  
    Text Color Select a color for the text on the page No Color Picker #000000  
    Logo Orientation Select where the logo should be positioned No Drop-down list Top Right  
    Image Orientation Select where the image should be positioned No Drop-down list Top Center  
    Text/Labels
    Error Message Message to display when there's an error retrieving the data. No String Unable to reach the service at this time. Please try again later  
    Import your File Here Select Choose File to select a file to import data No Button    
    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      
    • Was this article helpful?