Welcome to the documentation for WorkN public API endpoints. WorkN API follows a "loose" JSON-RPC format, meaning the endpoints are centered around procedures performed on the server rather than specific objects, as in a REST API structure.
Endpoint Overview
- Each API endpoint represents a distinct procedure.
- The method is inherently defined by calling a particular endpoint.
- Parameters are "named" parameters that are passed and returned in each API call.
HTTP Method
All API calls within the WorkN system use the HTTP POST method. This method is used for creating, adding, or updating information on the server, as well as for retrieving data.
Data Format
-
Request Parameters:
- Parameters must be sent in JSON format as a data payload.
- The header
Content-Type: application/jsonmust be included with each request.
-
Response Format:
- All returned values adhere to standard JSON format.
URL for API Calls
All API calls will be made to the following base URL: http://prod1.serveture.com/public-api/.
Date and Time Handling
All dates and times should be sent and received in Coordinated Universal Time (UTC).
Image Handling
-
Sending Images: Images sent to the WorkN system should be base64 encoded data streams included in the JSON payload.
-
Receiving Images: Returned image values are paths to the image, not the actual image data. Prepend the following URL to retrieve the actual image: http://prod1.serveture.com.