Skip to main content

Services Overview

This schema is available generation using this swagger openapi endpoint. It is highly recommended to generate schema before building api calls by hand.

Swagger Resources​

Use these resources for code generation tools and API evaluation:

Swagger Schema:​

Swagger Schema
https://dev.econnectclouddev.com/eventsbridge/swagger/v1/swagger.json

Swagger UI:​

Swagger UI
https://dev.econnectclouddev.com/eventsbridge/Swagger/index.html

Auth Services​

The Auth services are used to authenticate with Events Bridge and acquire a JWT token, which is required to access other services.

Auth Services

Login (/api/Auth/login): This endpoint allows partners to authenticate by providing their username and password. If successful, a JWT token is returned, which must be used in subsequent API requests to other endpoints. Renew Token (/api/Auth/renew-token): Once your JWT token is close to expiration, you can renew it using this endpoint to avoid re-authenticating. JWT Authentication All requests to the system must include a JWT token in the header for authorization. You will need to use the login endpoint to retrieve this token before interacting with the other APIs.

Face Recognition Services (FaceServices)​

The FaceServices APIs handle face monitoring within the system, allowing partners to enroll, check, and remove individuals from monitoring. Each individual enrollment is tied to a unique externalId, which is supplied by the partner, making it specific to their system.

Face Services

  • Monitor Face (/api/v1/faces/monitor/{externalId}): Enroll a person’s face into the system by submitting their externalId, photo, and optional tags. The externalId is provided by the partner, ensuring the enrollment is deterministic to them. Once enrolled, the system will monitor this face and report detections.
  • Check Face Monitoring Status (/api/v1/faces/monitor/{externalId}): Check whether a specific face, identified by the externalId, is currently being monitored.
  • Unmonitor Face (/api/v1/faces/monitor/{externalId}): Remove a face from the monitoring system by providing the externalId.
  • Get All Monitored Faces (/api/v1/faces/monitored): Retrieve a list of all currently monitored faces in the system.

License Plate Recognition Services (LprServices)​

The LprServices APIs allow partners to monitor vehicle license plates. Similar to face monitoring, the externalId (supplied by the partner) ensures that each enrollment is specific to their system.

Lpr Services

  • Monitor License Plate (/api/v1/lpr/monitor/{externalId}): Enroll a vehicle's license plate for monitoring by submitting the externalId, license plate data, and optional tags. The externalId is supplied by the partner, ensuring deterministic enrollment.
  • Check License Plate Monitoring Status (/api/v1/lpr/monitor/{externalId}): Verify if a specific license plate, identified by the externalId, is being monitored.
  • Unmonitor License Plate (/api/v1/lpr/monitor/{externalId}): Remove a vehicle's license plate from the monitoring system using the externalId.
  • Get All Monitored License Plates (/api/v1/lpr/monitored): Retrieve a list of all monitored license plates in the system.

For more details on using each API call, including sample requests and responses, visit the respective sections for Auth Services, FaceServices, and LprServices.