Skip to main content

Activating the Sensor

A Shigoto Sensor only needs to be activated once. During activation, the userId and customerId of the partner system are stored on the Shigoto Hub, and the Shigoto Sensor is permanently enabled for this user and customer by means of a signature.

To ensure that the Shigoto Sensor is only activated for a valid user of the partner system, the user is authorized by the partner system.

Activation flow​

  1. The Shigoto Sensor is installed on the user's computer and starts automatically.

  2. Since no activation exists yet, the Shigoto Sensor shows a window prompting for activation, in the form of an Activate button.

  3. When the user clicks this button, the Shigoto Sensor opens a partner website agreed upon with the partner and passes it the sensor id and the URL of the Shigoto Hub (e.g. qa.shigoto-labs.com) for the activation:

    https://<PartnerUrl>/sensor/Activate.html
        ?sensorId=<sensorId>
        &validTill=2026-06-09T21:59:59.000Z
        &target=<shigoto-hub-url>

    validTill is a timestamp that tells the called page how long the supplied sensorId remains valid.

  4. The Activate.html page should require a login to the partner system in order to authenticate the user. Initially it only shows the message "Sensor is being activated".

  5. Immediately after being opened, Activate.html calls a REST API on the partner system (e.g. https://<PartnerUrl>/sensor/activate?sensorId=<sensorId>&hub=<shigoto-hub-url>). This API receives a login token of the user, can fetch information about the user, and can use it to trigger the activation of the sensor on the Shigoto Hub. To do so, activate calls the Shigoto API AuthorizeSensor with an API key issued by Shigoto.

  6. Shigoto AuthorizeSensor reports success or an error, which the partner's activate API passes back to the Activate.html page.

  7. Since the Shigoto Sensor is connected to the Shigoto Hub and uniquely identified by its sensor id, AuthorizeSensor activates the Shigoto Sensor by signature immediately after the call.

  8. Right after activation, the Shigoto Sensor reports its first status to the partner system.