Integration Guide
Connect your application to Proxima RaaS in minutes.
Quick Start
Install the official Socket.io client to begin:
npm install socket.io-client
Establish Connection
To connect, use your Project ID in the URL and provide your API Key in the query parameters. You can also specify an optional Sub-Namespace.
Javascript Implementation
import { io } from "socket.io-client";
const API_KEY = "your_api_key_here";
const PROJECT_ID = "your_project_id";
const SUB_NAMESPACE = "chat"; // Optional sub-channel
const socket = io(`https://raas.example.com/project_${PROJECT_ID}`, {
query: {
apiKey: API_KEY,
namespace: SUB_NAMESPACE
}
});
Room Management
Create and join dynamic rooms for targeted messaging.
Join Room
socket.emit("join_room", {
room: "lobby"
});
Message Room
socket.emit("message", {
room: "lobby",
data: { text: "Hi Room!" }
});
Handling Messages
The platform uses a unified `message` event for cross-client communication.
Listening
socket.on("message", (payload) => {
// payload.data = your payload
});
Broadcasting
socket.emit("message", {
text: "Hello!",
timestamp: Date.now()
});