API Quickstart

In this guide, you will find detailed information on how to use this API, its methods and their parameters, error handling, and best practices. By the end of this documentation, you'll be well-equipped to integrate RapidMule API into your application and enhance user engagement and satisfaction with gamified journeys. Let's get started!

Prerequisites

Complete the following steps before making your first API call:

1. Receive the "account ready" confirmation from the RapidMule team.
2. Log in to the RapidMule back office and get your API key.

Typical Usage

Backend Integration Only

RapidMule is a SaaS platform designed for backend integrations. This API should be used by server-side applications that act as intermediaries between the client app and the API. It is not intended for direct client-side usage due to potential security risks such as exposing sensitive API keys or tokens.

Common usage includes:

• Integrating gamification logic into business workflows
• Triggering events from backend services
• Synchronizing user activity from an existing system to RapidMule

You may check this diagram for the recommended practices.

Authentication

All API requests require authentication using an API key in the request header.

Authorization: Bearer YOUR_API_KEY

Security

Keep your API key secure and never expose it in client-side code. Always use server-side applications to make API calls.

Base URL

All API requests should be made to:

https://api.rapidmule.com/v1

Making Your First Request

Here's a simple example of creating an action:

cURL

curl -X POST https://api.rapidmule.com/v1/action/process \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "login",
    "referenceId": "login-001",
    "playerId": "{{playerID}}"
  }'

JavaScript

const response = await fetch('https://api.rapidmule.com/v1/action/process', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'login',
    referenceId: 'login-001',
    playerId: '{{playerID}}'
  })
});

const result = await response.json();

Python

import requests

response = requests.post(
    'https://api.rapidmule.com/v1/action/process',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'login',
        'referenceId': 'login-001',
        'playerId': '{{playerID}}'
    }
)

result = response.json()

Response Format

All API responses follow a standardized JSON format:

{
  "code": 200,
  "data": {
    // Response data here
  }
}

• code: HTTP status code (200 for success)
• data: The actual response payload

For error responses, see the Error Handling section.