Skip to main content

Integration

Last Updated by Gil Ninveh on July 7th, 2024.

Overview​

This section explains how to integrate with the Edgify Agent by calling Edgify’s REST API endpoints. On this page you will find housekeeping and information on key configurations. Detailed information relating to the API calls and user flows is found on the following pages.

REST: API​

For the most up-to-date API information, we recommend using the Swagger documentation hosted as part of the agent installed on your edge device. Simply browse to: http://localhost:3000/docs/ on your Edgify-enabled device. Important: To satisfy the digest authentication, you must perform a one-time login via Swagger before you can start executing API calls.

If you want to see the Swagger Documentation without installing the Agent, you can view the Swagger Docs of the public agent.

alt text

Account Token​

Edgify licenses devices using an account token. This token links with a single account in the Edgify dashboard. The account token serves two purposes: authenticating devices and as the password for Digest Authentication.

Digest Authentication​

Our Agent uses digest authentication, where the username can be any string (we recommend your company name) and the password is your account token. Please ensure these credentials are easily configurable and not baked-in, as tokens are not shared between accounts.

Important Configurations​

1. Silent/Active Mode​

A toggle which shows/hides UI changes. The Edgify solution operates independent of the toggle, but in silent mode all on-screen predictions, interventions and general Edgify interactions are hidden from the user. Full API functionality should continue during silent mode, it is purely a visual change. We recommend binding this to a toggle button, and it is critical to enable remote switching. Silent mode allows Edgify to train our AI in the early stages of a deployment without negatively impacting customer experience.

2. Kill Switch​

In the unlikely event of an uncontrolled failure, there should exist the means to stop all communication between the application software and Edgify. This should be operable remotely and locally, we recommend a button accessible in the staff/attendant hidden menu.

3. Agent URL and Port​

Should be configurable to allow for using alternatives should the defaults be in-use or unavailable.

4. Timeout and Null Responses​

The application software should implement a timeout and be capable of handling null responses from the Edgify Agent.

Testing Without an Agent​

In the case that your local agent is unavailable, we offer a cloud-hosted agent which can be used to test your integration. This model should be used for testing API functionality only, and not relied on for accurate item recognition.

You can see the public agent here:

Edgify's Public Dev Agent UI