Skip to content

API Documentation

Andrew edited this page Jul 27, 2019 · 4 revisions

Allow2Unity API Documentation

The basic requirements of Allow2 are to:

  1. Pair - if a user chooses to enable Allow2, they click a button in your app to open up a pairing interface and connect to Allow2 using their account.
  2. Child Login - Once a device is paired, if there is only one child, or an allocated child, then you can simply start checking as per below, otherwise, use the list of children returned to show a child selection interface when a child needs to start using the app.
  3. Check for access and quota and log usage.
  4. Requests to allow children to request changes.

Pairing

To allow users to connect to Allow2, show a pairing dialog in your application.

The pairing mechanism for Allow2 has 2 options:

  1. QRCode Pairing - this is the simplest, users scan the qrcode and the app or device is connected to their Allow2 account.
  2. Login Pairing - this is a fallback option, present username and password fields and a "Pair" button to the user.

Typically, you show a single dialog with a qrcode for scanning and the login username/password fields and the "Pair" button, so users can simply use either method.

Clone this wiki locally