Overview

Source: https://github.com/digital-blueprint/relay-checkin-bundle

This bundle handles check-ins to places and contact tracing for warning about COVID-19 cases.

You will need to install and set up the Digital Blueprint fork of CampusQR, the open source system for contact tracing at universities.

See Check-in Website for more information.

There is a corresponding frontend application that uses this API at Check-in Frontend Application.

graph TD
    style checkin_bundle fill:#606096,color:#fff

    campusqr("Campus QR")

    subgraph API Gateway
        api(("API"))
        core_bundle("Core Bundle")
        checkin_bundle("Checkin Bundle")
    end

    api --> core_bundle
    api --> checkin_bundle
    checkin_bundle --> core_bundle
    checkin_bundle --> campusqr

Bundle Configuration

Created via ./bin/console config:dump-reference DbpRelayCheckinBundle | sed '/^$/d'

# Default configuration for "DbpRelayCheckinBundle"
dbp_relay_checkin:
  campus_qr_url:        ~
  campus_qr_token:      ~
  authorization:
    policies:             []
    roles:
      # Returns true if the user is allowed to check in.
      ROLE_LOCATION_CHECK_IN: 'false'
      # Returns true if the user is allowed to check in guests.
      ROLE_LOCATION_CHECK_IN_GUEST: 'false'
    resource_permissions: []
    attributes:           []

The bundle has a campus_qr_url and a campus_qr_token configuration value that you can specify in your app, either by hardcoding it, or by referencing an environment variable.

For this create config/packages/dbp_relay_checkin.yaml in the app with the following content:

dbp_relay_checkin:
  campus_qr_url: 'https://campusqr.your.domain'
  campus_qr_token: 'secret token'
  authorization:
    roles:
      ROLE_LOCATION_CHECK_IN: 'user.isAuthenticated()'
      ROLE_LOCATION_CHECK_IN_GUEST: 'false'

Roles:

• ROLE_LOCATION_CHECK_IN - needs to evaluate to true for the user to be allowed to check in
• ROLE_LOCATION_CHECK_IN_GUEST - needs to evaluate to true for the user to be allowed to check in guests. Also requires ROLE_LOCATION_CHECK_IN.