API de órdenes de 4casters

La API de órdenes de 4casters permite colocar y cancelar órdenes en tiempo real y gestionar la sesión por una conexión WebSocket cruda.

Endpoints

API de órdenes: wss://orders-api.4casters.io/orders/ws

Autenticación

La conexión se autentica con un token de 4Casters. Envía el token en el encabezado Authorization del handshake WebSocket. El servidor deriva el usuario a partir del token: sin nombre de usuario en la URL.

Obtener un token

No hay una clave de API aparte. Inicia sesión con tu nombre de usuario y contraseña de 4Casters llamando al endpoint /user/login de la API REST de 4Casters. La respuesta incluye un token que puedes usar aquí. Consulta Autenticación para la vida útil y la rotación del token. Consulta POST /user/login en la documentación de la API REST de 4Casters.

Conectar

const WebSocket = require('ws');
const token = process.env.FOURCASTERS_TOKEN;
const ws = new WebSocket('wss://orders-api.4casters.io/orders/ws', {
  headers: { Authorization: token },
});

Formato de mensajes

Cada solicitud del cliente es una 2-tupla [messageType, payload]. Cada payload debe incluir un requestID que tú generas; el servidor lo devuelve para que puedas correlacionar las respuestas.

[
  "messageType",
  {
    "requestID": "YOUR_REQUEST_ID",
    "...": "..."
  }
]

Las respuestas del servidor son objetos JSON con requestID más data (éxito) o error (fallo):

{
  "requestID": "YOUR_REQUEST_ID",
  "data": { "...": "..." }
}

{
  "requestID": "YOUR_REQUEST_ID",
  "error": "human-readable error"
}

​Endpoints

​Autenticación

​Obtener un token

​Conectar

​Formato de mensajes

Endpoints

Autenticación

Obtener un token

Conectar

Formato de mensajes