Evok APIs
For more information see our API documentation.
Evok APIs are listening on IP 127.0.0.1
and port 8080
by default. You can change this behavior in configuration.
Comparison table:
API | multiple commands per request | Recommended usage | Communication |
---|---|---|---|
REST | ❌ | By hand | client to Evok |
JSON | ❌ | Automated | client to Evok |
WebSocket | ❌ | Real-time automated | both ways |
BULK | ✅ | Automated | client to Evok |
Webhook | N/A | Listening to changes | Evok to client |
RPC | ❌ | Automated | client to Evok |
REST (doc)
The REST API provides a simple interface for sending and receiving data in a stateless, cacheable communications.
JSON (doc)
Similar to the REST API, but in JSON format.
WebSocket (doc)
The WebSocket API allows for two-way communication between the client and the server over an open connection. Evok sends changes to every connected client. A list of reflected devices can be defined. It is suitable if you need to immediately react to events in your application.
BULK (doc)
The BULK API is designed to provide an efficient way for clients to update, create or delete large amounts of data.
Webhook (doc)
The Webhook API provides a mechanism for pushing real-time updates to clients. Evok sends the changes to the specified hostname and port. A list of reflected devices can be defined. It is suitable for collecting real-time information about the application.
RPC (doc)
The RPC (Remote Procedure Call) API is used for invoking procedures, functions or methods across a network.