PHPackages                             teamvortexsoftware/vortex-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. teamvortexsoftware/vortex-php-sdk

ActiveLibrary[Authentication & Authorization](/categories/authentication)

teamvortexsoftware/vortex-php-sdk
=================================

Vortex PHP SDK for authentication and invitation management

1.18.0(2mo ago)0267↓86.7%MITPHPPHP >=8.0

Since Oct 31Pushed 2mo agoCompare

[ Source](https://github.com/TeamVortexSoftware/vortex-php-sdk)[ Packagist](https://packagist.org/packages/teamvortexsoftware/vortex-php-sdk)[ RSS](/packages/teamvortexsoftware-vortex-php-sdk/feed)WikiDiscussions main Synced 2d ago

READMEChangelogDependencies (2)Versions (14)Used By (0)

vortex-php-sdk
==============

[](#vortex-php-sdk)

[![Version](https://camo.githubusercontent.com/8795e1ab04838909482da2aaed67df150b6b1c584c1d26e860d5476f9872166f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e31382e302d626c7565)](https://camo.githubusercontent.com/8795e1ab04838909482da2aaed67df150b6b1c584c1d26e860d5476f9872166f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e31382e302d626c7565)[![Language](https://camo.githubusercontent.com/ff57355edf84257ccd41b2fc9426b2fc17bb7758d860ae8774eb0ab894fd666c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c616e67756167652d7068702d677265656e)](https://camo.githubusercontent.com/ff57355edf84257ccd41b2fc9426b2fc17bb7758d860ae8774eb0ab894fd666c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c616e67756167652d7068702d677265656e)

**Invitation infrastructure for modern apps**

Vortex handles the complete invitation lifecycle — sending invites via email/SMS/share links, tracking clicks and conversions, managing referral programs, and optimizing your invitation flows with A/B testing. [Learn more about Vortex →](https://tryvortex.com)

Why This SDK?
-------------

[](#why-this-sdk)

This backend SDK securely signs user data for Vortex components. Your API key stays on your server, while the signed token is passed to the frontend where Vortex components render the invitation UI.

- Keep your API key secure — it never touches the browser
- Sign user identity for attribution — know who sent each invitation
- Control what data components can access via scoped tokens
- Verify webhook signatures for secure event handling

How It Works
------------

[](#how-it-works)

Vortex uses a split architecture: your backend signs tokens with the SDK, and your frontend renders components that use those tokens to securely interact with Vortex.

```
┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│   Your Server   │     │  User Browser   │     │  Vortex Cloud   │
│    (this SDK)   │     │   (component)   │     │                 │
└────────┬────────┘     └────────┬────────┘     └────────┬────────┘
         │                       │                       │
         │  1. generateToken()   │                       │
         │◄──────────────────────│                       │
         │                       │                       │
         │  2. Return token      │                       │
         │──────────────────────►│                       │
         │                       │                       │
         │                       │  3. Component calls   │
         │                       │     API with token    │
         │                       │──────────────────────►│
         │                       │                       │
         │                       │  4. Render UI,        │
         │                       │     send invitations  │
         │                       │◄──────────────────────│
         │                       │                       │

```

### Integration Flow

[](#integration-flow)

**1. Install the backend SDK** `[backend]`

Add this SDK to your PHP project

```
composer require teamvortexsoftware/vortex-php-sdk
```

**2. Initialize the client** `[backend]`

Create a Vortex client with your API key (keep this on the server!)

```