API Documentation

This HTTP based API is the general interface for the Sereact picking system. This document covers the basic functionality to be used from an outside entity (e.g. WMS).

Introduction to the Sereact Picking System API

Welcome to the Sereact Picking System API, a versatile and loosely coupled message-based application designed to facilitate seamless communication between different nodes within a system.

API Overview

The Sereact Picking System API serves as the entry point to the entire system, offering two communication options: HTTP POST and Websocket transport. This flexibility allows you to choose the method that best suits your application's requirements.

HTTP POST Usage

To utilize the API via HTTP POST, send your calls as raw JSON data to the following endpoint:

-

Simply configure the IP address of your system, and the request will be processed in a blocking manner until fully executed. For asynchronous operations, we recommend leveraging our Websocket API.

Websocket Communication

For a dynamic and real-time interaction, connect a standard Websocket to:

-

Once connected, send the same messages to the websocket channel, and the server will respond through the same channel. Note that responses may not be in order, emphasizing the importance of setting an ID on your requests. The websocket server will reply with a result message containing the corresponding ID.

Asynchronous Operation

Requests to the websocket transport are non-blocking (send-and-forget). To stay informed about the completion of a request, actively listen to the responses. This ensures that you receive notifications as soon as a request is finished.

Explore the comprehensive capabilities of the Sereact Picking System API, leveraging both HTTP POST and Websocket communication for a tailored and efficient integration with your system.

{/* 

 */}