Usage - usil/eventhos-api GitHub Wiki
First run npm install
. To start development run npm run dev:start
.
For production you should build your app npm run build
will create a dist file. Then run npm start
.
Once the application is running you can either use the eventhos platform (recommended) or use the endpoints that this api has.
First using the /auth/client
endpoint to crate a client. Check the oauth2-starter library to know all of the authentication endpoints.
To use eventhos first you should create a system
then create an event
for this system, after that create other system
but for this one create an action
. To link the event with the action create a contract
.
Finally make someone use the /event?access-key=<client-token>&event-identifier=<event-identifier>
endpoint to call an event
that will trigger one or more contracts
those contract will make some actions
happen.
To know more about system
, event
and contract
take a look at the full documentation.