Microservice implemented from Messages Core is responsible for sending events messages through some real time providers such as NATS or MQTT.
As explained in the Messages Core repository, it can be seen that there are three models, messages, channel and provider. To know more you can read the readme of Messages Core.
Corresponds to the type of notification that could be sent, for this there must be the implementation of that channel as a gRPC service through an API.
The provider is an attribute of channel and allows to identify what types of messages are available for a specific channel.
In this api we will find the implementation of only 3 providers. Find Providers implementation at the ./provider folder.
| Name | Protocol | Description | ENV (each with prefix PROVIDER_) |
|---|---|---|---|
| Nats | nats | On premise its free. | NATS_API_KEY: string |
| MQTT | mqtt | On premise its free. | MQTT_API_KEY: string |
| AWS Events | mqtt | Coming soon. | Coming soon. |
| Azure Events | mqtt, amqp, http | Coming soon. | Coming soon. |
service MessageBackendService {
rpc Approve(MessageBackendApproveRequest) returns (MessageBackendApproveResponse) {}
rpc Deliver(MessageBackendDeliverRequest) returns (MessageBackendDeliverResponse) {}
}Event {
topic: string
payload: map[string]string
Provider: string // nats, mqtt
}make build: build user service for osx.
make linux: build user service for linux os.
make docker: build docker.
docker run -it -p 5060:5060 events-api: run docker.
Run Events API:
HOST=<host> \
PORT=<port> \
REDIS_HOST=<redis-host> \
REDIS_PORT=<redis-port> \
REDIS_DATABASE=<redis-database> \
PROVIDERS=<providers> \
PROVIDER_NATS_API_KEY=<providers-nats-api-key> \
PROVIDER_NATS_HOST=<providers-nats-host>
PROVIDER_NATS_PORT=<providers-nats-port> \
PROVIDER_MQTT_API_KEY=<providers-nats-api-key> \
./bin/events-api- Task 1.
- Task 2.
- Task 3.