RecoverKit developer docs

mkdir -p recoverkit-php && cd recoverkit-php
curl -fsSL -O https://recoverkit.padiconnect.com/sdk/php/RecoverKit.php

<?php
require_once __DIR__ . '/recoverkit-php/RecoverKit.php';
$rk = new RecoverKit(getenv('RK_PUBLIC_KEY'), getenv('RK_SECRET_KEY'), getenv('RK_ENDPOINT'));

// After sign-up or login:
$rk->identify(['email' => $user->email, 'phone' => $user->phone, 'firstName' => $user->first_name]);

// when a payment for an order really succeeds (amount in kobo):
$rk->trackPurchase(['email' => $user->email, 'amount' => 150000, 'ref' => $order->reference]);

npm install recoverkit

import { RecoverKit } from 'recoverkit';
const rk = new RecoverKit({
  publicKey: process.env.RK_PUBLIC_KEY,
  secretKey: process.env.RK_SECRET_KEY,
  endpoint: process.env.RK_ENDPOINT,
});

// After sign-up or login:
await rk.identify({ email: user.email, phone: user.phone, firstName: user.firstName });

// when a payment for an order really succeeds (amount in kobo):
await rk.trackPurchase({ email: user.email, amount: 150000, ref: order.reference });

import hashlib, os, requests

PK, SK, BASE = os.environ["RK_PUBLIC_KEY"], os.environ["RK_SECRET_KEY"], os.environ["RK_ENDPOINT"]

def rk_id(kind, value):  # kind "e" = email (trimmed, lower case), "p" = phone (digits with country code)
    return hashlib.sha256(f"rk1|{PK}|{kind}|{value}".encode()).hexdigest()

def rk_send(email, events=None, first_name=None):
    body = {"ids": [rk_id("e", email.strip().lower())], "contact": {"email": email, "firstName": first_name}}
    if events: body["events"] = events
    try:
        requests.post(f"{BASE}/v1/server/events", json=body, timeout=3,
                      headers={"Authorization": f"Bearer {SK}"})
    except requests.RequestException:
        pass  # never let RecoverKit break your checkout

rk_send(user.email, first_name=user.first_name)                      # after sign-up or login
rk_send(user.email, [{"type": "purchase", "amount": 150000, "ref": order.ref}])  # a real sale, in kobo

curl -X POST https://recoverkit.padiconnect.com/v1/server/events \
  -H "Authorization: Bearer $RK_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["<sha256 of rk1|rk_pub_YOUR_PUBLIC_KEY|e|customer@example.com>"],
       "events": [{"type": "purchase", "amount": 150000, "currency": "NGN", "ref": "ORDER-1001"}]}'

mkdir -p ~/recoverkit-php && cd ~/recoverkit-php
curl -fsSL -O https://recoverkit.padiconnect.com/sdk/php/RecoverKit.php -O https://recoverkit.padiconnect.com/sdk/php/recoverkit-connector.php -O https://recoverkit.padiconnect.com/sdk/php/recoverkit-detect.php

export RK_PUBLIC_KEY=rk_pub_YOUR_PUBLIC_KEY
export RK_SECRET_KEY=rk_sec_YOUR_SECRET_KEY
export RK_ENDPOINT=https://recoverkit.padiconnect.com

php recoverkit-connector.php setup --app=/path/to/your/app
php recoverkit-connector.php sync

*/15 * * * * cd $HOME/recoverkit-php && php recoverkit-connector.php sync --app=/path/to/your/app >> sync.out 2>&1

cd /path/to/your/app
npx recoverkit-connector@1 setup --app=.
npx recoverkit-connector@1 sync --app=.

*/15 * * * * cd /path/to/your/app && npx recoverkit-connector@1 sync --app=. >> recoverkit-sync.out 2>&1

docker build -t recoverkit-connector https://github.com/Light8749/recoverkit.git#main:sdk/php

docker run --rm -it --network host -v /path/to/your/app:/app:ro -v recoverkit-state:/state \
  -e RK_PUBLIC_KEY -e RK_SECRET_KEY -e RK_ENDPOINT recoverkit-connector setup --app=/app --dir=/state