@universis/escn

Universis API server plugin for managing the European student cards

Usage

Install plugin

npm i @universis/escn

Configure

Register @universis/escn#EscnService in application services:

# app.production.json

"services": [
    ...,
    {
        "serviceType": "@universis/escn#EscnService"
    }
]

Add @universis/escn#EscnSchemaLoader to schema loaders:

# app.production.json

{
    "settings": {
        "schema": {
            "loaders": [
                ...,
                {
                    "loaderType": "@universis/escn#EscnSchemaLoader"
                }
            ]
        }
    }
}

Add keychain object for the escRouter with the API key:

# app.production.json

{
    "settings": {
        "universis": {
            "keychain": [
                {
                    "identifier": "escRouter",
                    "apikey": ""
                },
            ]
        }
    }
}

All related to this library settings are set under settings/universis/escn:

# app.production.json

{
    "settings": {
        "universis": {
            "escn": {
                "api": "ESC-R_API_URL",
                "key": "YOUR_API_KEY",
                "enableListeners": true (to automatically handle ESCs on student status change)
            }
        }
    }
}