Authorization - Plandalf

Agents are users who are authorized to act on behalf of a customer. Plandalf supports many different types of agent-customer relationships, such as:

The Agent is the customer (1-1)
The Agent is a member of a group which acts as the customer (many-1)
The Agent is a member of multiple groups which belong to the same customer (1-many)
The Agent is a member of multiple groups, where each group is a separate customer (many-many)

JWT authorization

Plandalf SDK is authorized using a JWT signed with the api secret for your client.

Claims

# Required Fields
sub: <USER_IDENTIFIER>

# Optional (but recommended) Fields
customer: <CUSTOMER_IDENTIFIER>
grp: <GROUP_IDENTIFIER>
exp: <TOKEN_EXPIRY_TIMESTAMP>
email: <USER_EMAIL_ADDRESS>

# Sandbox field (configures a 100% off coupon)
aud: sandbox

Node.js

jsonwebtoken is a popular library for creating and verifying JWTs. Install jsonwebtoken

npm install jsonwebtoken

Create a JWT and pass it to your front end template

import jwt from 'jsonwebtoken';

let token = jwt.sign(claims, "<SECRET>", {algorithm: 'RS256', keyid: '<CLIENT_ID>'});

At this point, the JWT token can be passed to the front end template and used to initialize the plandalf SDK.

PHP

composer require firebase/php-jwt

use \Firebase\JWT\JWT;

$token = JWT::encode($claims, $secret, 'RS256', '<CLIENT_ID>');

Example claims

{
    "sub": "user_abc123",
    "exp": 1721234567,
    "aud": "sandbox",
    "email": "foundo@plandalf.com",
    "customer": "cus_NffrFeUfNV2Hib",
}