https://github.com/little-green-man/stytch-php
https://github.com/little-green-man/stytch-php
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/little-green-man/stytch-php
- Owner: little-green-man
- License: mit
- Created: 2024-05-17T12:48:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-02T07:17:49.000Z (about 1 year ago)
- Last Synced: 2025-02-15T18:52:01.189Z (4 months ago)
- Language: PHP
- Size: 637 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stytch PHP Library
The Stytch PHP library makes it easy to use the Stytch user infrastructure API in server-side PHP applications.
This library is compatible with PHP 8.0+
## Install
```bash
composer require little-green-man/stytch-php
```
## Usage
You can find your API credentials in the [Stytch Dashboard](https://stytch.com/dashboard/api-keys).
This client library supports all of Stytch's live products as follows:
> Note: This library is in development. The features below are being built out incrementally, and the SDK may have breaking changes until a stable release.
**B2C**
- [ ] [Email Magic Links](https://stytch.com/docs/api/send-by-email)
- [ ] [Embeddable Magic Links](https://stytch.com/docs/api/create-magic-link)
- [ ] [OAuth logins](https://stytch.com/docs/api/oauth-google-start)
- [ ] [SMS passcodes](https://stytch.com/docs/api/send-otp-by-sms)
- [ ] [WhatsApp passcodes](https://stytch.com/docs/api/whatsapp-send)
- [ ] [Email passcodes](https://stytch.com/docs/api/send-otp-by-email)
- [ ] [Session Management](https://stytch.com/docs/api/session-auth)
- [ ] [WebAuthn](https://stytch.com/docs/api/webauthn-register-start)
- [ ] [User Management](https://stytch.com/docs/api/create-user)
- [ ] [Time-based one-time passcodes (TOTPs)](https://stytch.com/docs/api/totp-create)
- [ ] [Crypto wallets](https://stytch.com/docs/api/crypto-wallet-authenticate-start)
- [ ] [Passwords](https://stytch.com/docs/api/password-create)
**B2B**
- [x] [Organizations](https://stytch.com/docs/b2b/api/organization-object)
- [x] [Members](https://stytch.com/docs/b2b/api/member-object)
- [x] [RBAC](https://stytch.com/docs/b2b/api/rbac-resource-object)
- [x] [Email Magic Links](https://stytch.com/docs/b2b/api/send-login-signup-email)
- [x] [OAuth logins](https://stytch.com/docs/b2b/api/oauth-google-start)
- [ ] [Session Management](https://stytch.com/docs/b2b/api/session-object)
- [ ] [Single-Sign On](https://stytch.com/docs/b2b/api/sso-authenticate-start)
- [ ] [Discovery](https://stytch.com/docs/b2b/api/discovered-organization-object)
- [ ] [Passwords](https://stytch.com/docs/b2b/api/passwords-authenticate)
- [ ] [SMS OTP (MFA)](https://stytch.com/docs/b2b/api/otp-sms-send)
- [ ] [M2M](https://stytch.com/docs/b2b/api/m2m-client)
**Shared**
- [ ] [M2M](https://stytch.com/docs/api/m2m-client)
### Example B2C usage
TBD.
### Example B2B usage
Create an API client:
```php
$stytch = new StytchB2B(
new ClientBuilder(
secret: 'secret-test-...',
project: 'project-test-...',
publicToken: 'public-token-test-...',
authUri: '/authentication',
testMode: true
)
);
```
Create an organization
```php
$response = $stytch->organizations()->create('Test Organization', 'test-org');
$organization = $response->organization;
```
## Handling Errors
Each response includes a boolean method `wasSuccessful()`, which can be tested before trying to access response data.
If the response was not successful, you can access the Stytch error details as follows:
```php
$response->error_message;
$response->error_type;
$response->error_url;
```
If the mapper is unable to hydrate the response, it will throw an exception. This might be due to mismatches between the SDK and the Stytch API, please raise an issue if you encounter this.
Learn more about Stytch errors in the [docs](https://stytch.com/docs/api/errors).
## Customizing the HTTPS Client
The Stytch client uses PSR 18 Client Discovery to find the first client that implements Psr\Http\Client\ClientInterface. It does this to avoid multiple or conflicting clients being installed in your app.
If you don't have one in the project, just require one (like Guzzle).
If you want to use a specific client, you can pass it to the Stytch ClientBuilder (see Install above).
## Documentation
See example requests and responses for all the endpoints in the [Stytch API Reference](https://stytch.com/docs/api).
Follow one of the [integration guides](https://stytch.com/docs/guides) or start with one of our [example apps](https://stytch.com/docs/example-apps).