Documentation

Everything you need to integrate Permitly into your application.

License Management

Issue and validate software licenses easily.

Paywalls

Drop-in components to lock features.

Quick Start

Get up and running in less than 5 minutes.

1

Create a Project

Go to your Dashboard and click "Create New Project".

2

Get API Keys

Copy your public project_key and secret from the project settings.

3

Install SDK

bash
npm install @permitly/react

SDK Integration

React Provider

Wrap your application root with the provider.

tsx
import { PermitlyProvider } from '@permitly/react';

export default function App({ children }) {
  return (
    <PermitlyProvider project="pk_live_..." api="https://api.permitly.com">
      {children}
    </PermitlyProvider>
  );
}

Protecting Content

tsx
import { usePermitly } from '@permitly/react';

export function Feature() {
  const { isAllowed } = usePermitly();

  if (!isAllowed) return <Paywall />;
  
  return <div>Premium Content</div>;
}

API Reference

Direct HTTP endpoints for backend integration.

POST/api/license/check

Verifies if a specific domain or user is allowed to access the project.

Body
json
{
  "projectKey": "pk_live_...",
  "domain": "example.com"
}