website·Indexed 32 days ago
https://docs.imkit.io/Core API service for the IMKIT Chat Server developed by FUNTEK. Provides comprehensive tools for messaging backend services, including user management, token issuance, chat room administration, and message operations such as sending, recalling, and pinning messages.
IMKIT allows applications with existing authentication systems to generate and verify their own user tokens and assign them to the IMKIT Chat Server. In this mode, IMKIT handles messaging while the developer's system manages the token lifecycle and verification logic.
Implementation Flow:
/admin/clients API to create a Client, providing the custom token and an expiration date.IM-CLIENT-KEY) is a public authentication key used to identify applications in the IMKIT Platform API. Unlike the API Key, which provides administrative access, the Client Key is designed for frontend use and must be paired with a user Token (IM-Authorization) to perform operations on behalf of a specific user. It is primarily used for SDK initialization, establishing WebSocket connections, and user-level API operations.IM-API-KEY) is a long-lived, Base64-encoded authentication key used exclusively for backend services. It grants full management permissions, allowing the holder to operate as a platform administrator. Unlike the Client Key, it is used independently and does not require a user Token. Because it provides full control over user management, chat rooms, and system settings, it must be kept strictly confidential and never exposed on the frontend.Once authenticated, clients can receive the following real-time events:
chat message: New message received.room: Chat room properties (members, settings) changed.lastRead: Member updated their last read marker.typing: Member is typing.ai_streaming: AI message streamed in chunks.roomPref: User updated a room preference.myPrefChange: User updated a personal preference.myPrefDelete: User deleted a personal preference.invitation: Group invitation received.userDeleteMessages: User deleted their own view of messages.messageDeleted: Admin permanently deleted a message.Use the GET /blockStatus/my endpoint to retrieve a complete list of users blocked by the current authenticated user. The response includes detailed information about the blocked user (blockee), the user who performed the block (blocker), the associated chatroom, and the timestamps for when the block was created and updated. This is used for privacy management, such as reviewing blocked users or implementing an unblock interface.
Constraints & Notes:
curl -X "GET" "https://your-app.imkit.io/blockStatus/my" \
-H 'IM-CLIENT-KEY: {IM-CLIENT-KEY}' \
-H 'IM-Authorization: {IM-Authorization}'const response = await axios.get(
`https://your-app.imkit.io/blockStatus/my`,
{
headers: {
"IM-CLIENT-KEY": IM_CLIENT_KEY,
"IM-Authorization": TOKEN,
},
}
);auth2 event. If authentication fails, the server will close the connection, and the client should trigger its reconnect flow. Note that auth2 must be called again after every socket reconnection.function auth() {
const token = "{IM-Authorization}";
const extra = {
deviceId: "iphone-15-pro-uuid-001" // Should match value used for push token registration
};
socket.emit("auth2", token, extra, (ack) => {
console.log("[socket] auth ack:", ack);
});
}updatedAfter parameter. Store the timestamp from the last successful request and pass it into the next request to fetch only rooms that have new messages or were created since that time.When deleting runtime configurations (such as sensitive word censorship), keep the following constraints and recommendations in mind:
transports: ['websocket'] and forceNew: true to ensure a clean connection.import { io } from "socket.io-client";
const socket = io("https://your-app.imkit.io", {
forceNew: true,
transports: ["websocket"]
});
socket.on("connect", () => {
console.log("[socket] connected");
});