Cricap Mini App SDK Documentation

Official JavaScript SDK for building mini apps on the Cricap platform. Build, deploy, and monetize your games with seamless integration.

npm install @cricap/miniapp-sdk

import { initCricapSDK } from '@cricap/miniapp-sdk';

const sdk = initCricapSDK({
  appId: 'miniapp_your_id',
  environment: 'production',
  debug: true,
});

const result = await sdk.initialize();
if (result.success) {
  await sdk.ui.show({ animation: 'slide-up' });
}

Overview

The Cricap Mini App Ecosystem enables third-party developers to build applications that run within the Cricap platform. This SDK provides seamless integration with authentication, user data, leaderboards, wallet, and real-time notifications.

Installation

npm

npm install @cricap/miniapp-sdk

yarn

yarn add @cricap/miniapp-sdk

SDK Initialization

UI Container Methods

Show Mini App

await sdk.ui.show({
  animation: 'slide-up',
  style: 'sheet',
  overlay: true,
  closeOnBackdrop: true
});

Notification System

await sdk.notifications.subscribe([
  'leaderboard.updates',
  'wallet.transactions'
]);

sdk.notifications.onNotification((notification) => {
  console.log('Received:', notification);
});

Backend API - Authentication

Base URLs

Token Exchange

// Request
{
  "grantType": "authorization_code",
  "code": "auth_code_from_container",
  "appId": "miniapp_abc123",
  "appSecret": "sk_live_xxxxxxxx"
}

// Response
{
  "success": true,
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIs...",
    "refreshToken": "rt_xxxxxxxx",
    "tokenType": "Bearer",
    "expiresIn": 3600
  }
}

Backend API - User

Get User Profile

// Response
{
  "success": true,
  "data": {
    "userId": "user_xyz789",
    "username": "gamer123",
    "displayName": "Pro Gamer",
    "avatarUrl": "https://cdn.cricap.com/avatars/xyz789.png"
  }
}

Backend API - QCoin System

Update QCoin Balance

// Request
{
  "amount": 100,
  "reason": "Game reward"
}

// Response
{
  "message": "QCoin balance updated",
  "balance": 500,
  "change": 100
}

Webhooks

Event Types

Frequently Asked Questions