Download the PHP package turanct/engagor-api without Composer
On this page you can find all versions of the php package turanct/engagor-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package engagor-api
Clarabridge Engage Api
Install
Via Composer
Or manually add turanct/engagor-api to your composer.json and run composer install.
Usage
Setting up
For this library to work, you'll need a PSR-7, PSR-17 and PSR-18 implementation. It doesn't really matter which ones, but an easy way to get started is to use these in your composer.json and then run composer install.
In this case PSR-7 and PSR-17 implementations are provided by nyholm/psr7 and the PSR-18 implementation is kriswallsmith/buzz.
Authentication
Create an Authentication instance:
Once you have created this instance, you can use it to authenticate the user of your app with Engage:
This will return an array that you can redirect your users too. Insert a random state, and save it in the user's session so that you can verify later on that the redirect URL that the user will be sent to is valid.
That redirect URL will look a bit like this:
You should verify the state to be the same that you generated when you called step1() to create the redirect URL in the previous step. If that check succeeds, the code that's also in the request to your redirect endpoint is what you'll need for the next step:
If it's successful, you should get a Tokens object, which holds the access & refresh tokens that we can use to issue calls to the Engage api.
Making authenticated requests to the API
Now that you've obtained a Tokens object, you can create a Client instance:
The $httpClient and $httpRequestFactory can be the same instances as described in the Authentication step above.
Now that you've got an API $client instance, you can either call the implemented API methods using the methods with their name, e.g. /me will be called me(), or you can use the request() method to manually make requests to the API.
or
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of engagor-api with dependencies
psr/http-message Version ^1.0
psr/http-client Version ^1.0
psr/http-factory Version ^1.0