Skip to main content

Introduction and Quick Start

Realtime simplifies the process of managing and handling long-lived connections via websockets. By offering a straightforward API, it can seamlessly integrate into your projects with some adjustments to your client and server.

No Need for Third-Party Libraries

A key feature of Ripplefy is its compatibility with standard programming libraries. You can use the standard library of your preferred programming language to make requests to our REST API and establish connections with our websocket server. This eliminates the need to install and manage any third-party libraries, thus streamlining your development process.

Here are the core concepts to incorporate it into your project:

  • Project Creation and Secret Key: After creating a new project, you will receive a Secret Key. This key is private and should not be shared; please ensure its security.

  • Backend Integration with Ripplefy API: Integrate your project's backend with the Ripplefy API. The API provides endpoints for various operations such as registering a new user (on a per-session basis), managing user subscriptions, and sending messages.

  • Frontend Integration with Ripplefy Websocket: On the frontend, establish a connection to the Ripplefy Websocket using the standard library of your preferred programming language. After registering a new user (on a per-session basis), you will receive an authentication token for this user. This token is used to authenticate the user for the websocket connection.

Quick Start​

This section provides a simple outline of steps you need to take when setting up and using Ripplefy, divided into backend and client-side (frontend) operations.

Backend: These refer to the tasks that need to be performed on your application's backend.

Client: These pertain to the tasks that should be executed on your client applications, also known as the frontend.

  1. (Backend) Create your Project: Establish your project and obtain your secretKey.

  2. (Backend) Register a New User: Enroll a new user and their session for your application, which will generate an authentication token.

  3. (Client) Connect Client to Websocket: Use the aforementioned token in your client application to establish a connection to the websocket. This will enable your client to receive messages.

  4. (Backend) Send Messages to Users: Once connected, you can start dispatching messages to your users.