internetofus/service-api repository overview

⁠What is the Service APIs component?

The Service APIs component is the one responsible for allowing WeNet applications to integrate with the WeNet platform. It is responsible for coordinating the communication between third party applications and the various components of the platform.

It exposes dedicated endpoints allowing to manage:

• applications;
• users;
• user profiles;
• tasks and the associated transactions.

The APIs defined in this component are meant to be used by:

other components of the WeNet platform; WeNet applications.

⁠How to use this image

The following environment variables are required for running the image:

APIKEY

apikey required for authenticating the incoming requests

COMP_AUTH_KEY

apikey required in order to authenticate on kong, this is required in order to forward the requests to the internal components.

COMP_AUTH_KEY_HEADER

the header name used in combination with COMP_AUTH_KEY, the default value is x-wenet-component-apikey

PROFILE_MANAGER_CONNECTOR_BASE_URL

base url for the profile manager connection

TASK_MANAGER_CONNECTOR_BASE_URL

base url for the task manager endpoints

PROFILE_MANAGER_CONNECTOR_BASE_URL

base url for wenet hub (ex. https://wenet.u-hopper.com/dev/hub/frontend⁠)

DEBUG

if set put the ws in "DEBUG" mode (use dummy endpoint for profile and task manager instead of the production one)

LOGGER_CONNECTOR_BASE_URL

base url for logger component