Portex SDK

Portex SDK is designed for Telegram Web App, providing the following main features:

• User Verification
• Social Features (Friend Invitation)
• Payment Features (Payment, Order Query)

Quick Start

Reference https://sdk.portex.app/portex-sdk.min.js

// Initialize SDK
const portex = new Portex({
  appId: 'your-app-id',
  environment: 'prod' // or 'dev'
});

// Initialize and verify user
await portex.init();

// Invite friends
const inviteResult = await portex.invite({
  expire: 3600, // Expiration time (seconds)
  text: 'Come play with me!',
  payload: 'custom-data'
});
Copy

Development

# Install dependencies
pnpm install

# Build
pnpm build

# Test
pnpm test
Copy

API Documentation

portex.init(): Promise

Initialize SDK and verify user.

interface VerifyResult {
  status: 'ok' | 'failed' | 'pending';
  timestamp: number;
}
Copy

portex.isVerified(): boolean

Check if user is verified.

portex.invite(options: InviteOptions): Promise

Friend invitation interface.

interface InviteOptions {
  expire: number;      // Expiration time (seconds)
  text?: string;       // Share text
  payload?: string;    // Custom data
}

interface InviteResult {
  invite_url: string;  // Invitation link
  key: string;         // Invitation ID
}
Copy

portex.queryInvitePayload(key: string): Promise

Get invitation information

interface InvitePayloadResult {
  payload: string;  // Invitation payload
}
Copy

License

MIT