Skip to main content
Version: Release

Overview

Authentication​

  • The SeeSo SDK requires Authentication process with SeeSo License Key.

  • The License Key is generated in SeeSo Console webpage.

  • The Authentication process is placed in GazeTracker initialization step of SeeSo SDK.

Authentication Result​

  • The Authentication process with License Key will pass or return result/error code.

    • Web SDK will pass the result/error code as a return value(enum) of the initialization function.

    • C++ SDK will pass the result/error code as a return value(int) of the initialization function.
      (Will be changed in the upcoming release)

    • Other SDK will pass the result/error code(enum) through an initialization callbacks.

⚠️ Authentication fails
It is encouraged for the developer to retry authentication a few more times when it fails with the following codes, due to some connectivity / scaling issues that may occur temporarily.
If the issue keeps happening, please report to us.

  • AUTH_SERVER_ERROR
  • AUTH_CANNOT_FIND_HOST

  • There are several types of result/error codes in enum/int format
    Prefer the named variable instead of the raw value if possible.

    • 0: ERROR_NONE
      • Authentication success.
    • 1: ERROR_INIT
      • Initialization fail.
    • 2: ERROR_CAMERA_PERMISSION
      • Failed to get camera permission.
    • 3: AUTH_INVALID_KEY
      • The license key is invalid.
    • 4: AUTH_INVALID_ENV_USED_DEV_IN_PROD
      • Trying to use dev license key in prod environment.
    • 5: AUTH_INVALID_ENV_USED_PROD_IN_DEV
      • Trying to use prod license key in dev environment.
    • 6: AUTH_INVALID_PACKAGE_NAME
      • Using wrong package name(Android / iOS).
    • 7: AUTH_INVALID_APP_SIGNATURE
      • Using wrong application signature(Android / iOS).
    • 8: AUTH_EXCEEDED_FREE_TIER
      • The free usage limit is exceeded.
    • 9: AUTH_DEACTIVATED_KEY
      • Trying to use deactivated license key.
    • 10: AUTH_INVALID_ACCESS
      • Invalid access.
    • 11: AUTH_UNKNOWN_ERROR
      • Unknown error from the host server.
    • 12: AUTH_SERVER_ERROR
      • Internal error from the host server.
    • 13: AUTH_CANNOT_FIND_HOST
      • Lost connection or using wrong host address.
        It may occur if the internet connection is unstable.
    • 14: AUTH_WRONG_LOCAL_TIME
      • There is a gap between the device time and the server time.
    • 15: AUTH_INVALID_KEY_FORMAT
      • Using wrong license key format.
    • 16: AUTH_EXPIRED_KEY
      • Using expired license key.
    • 17: ERROR_NOT_ADVANCED_TIER
      • Trying to use User-Status-Module with basic production license key.