Download the PHP package nexmo/jwt without Composer
On this page you can find all versions of the php package nexmo/jwt. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package jwt
Short Description A standalone package for creating JWTs for Nexmo/Vonage APIs
License MIT
Informations about the package jwt
JWT Client Library for PHP
This library requires a minimum PHP version of 7.1
This is the PHP library for generating JWTS to use Nexmo's API. To use this, you'll need a Nexmo account. Sign up for free at nexmo.com.
- Installation
- Usage
- Examples
- Contributing
Installation
To use the client library you'll need to have created a Nexmo account.
To install the PHP client library to your project, we recommend using Composer.
You don't need to clone this repository to use this library in your own projects. Use Composer to install it from Packagist.
If you're new to Composer, here are some resources that you may find useful:
- Composer's Getting Started page from Composer project's documentation.
- A Beginner's Guide to Composer from the good people at ScotchBox.
Usage
If you're using Composer, make sure the autoloader is included in your project's bootstrap file:
Create a Token Generator with the Application ID and Private Key of the Nexmo Application you want to access:
You can then retrieve a generated JWT token by calling the generate()
method on the Token Generator:
This will return a string token that can be used for Bearer Authentication to Nexmo APIs that require JWTs.
Examples
Generating a token with a specific Time To Live
By default, Nexmo JWT tokens are generated with an Time To Live, or TTL, of 15 minutes after generation. In cases where the token lifetime
should be different, you can override this setting by calling the setTTL()
method on the Token Generator and passing the length of seconds
that the token should be valid for
Setting ACLs
Nexmo JWTs will default to full access to all of the paths for an application, but this may not be desirable for cases where clients
may need restricted access. You can specify the paths that a JWT token is valid for by using the setPaths()
or addPath()
methods
to set the path information in bulk, or add individual paths in a more fluent interface.
For more information on assigning ACL information, please see How to generate JWTs on the Nexmo Developer Platform
Contributing
This library is actively developed and we love to hear from you! Please feel free to create an issue or open a pull request with your questions, comments, suggestions and feedback.