Download the PHP package ogillot/php-crisp-api without Composer
On this page you can find all versions of the php package ogillot/php-crisp-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
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.
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 PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- 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.
Please rate this library. Is it a good library?
Informations about the package php-crisp-api
Crisp API PHP
Installation with composer
composer require crispchat/php-crisp-api
Authentication
To authenticate against the API, generate your session identifier and session key once using the Crisp token generation utility. You'll get a token keypair made of 2 values.
Keep your token keypair values private, and store them safely for long-term use.
Then, add authentication parameters to your client instance right after you create it:
🔴 Important: Make sure to generate your token once, and use the same token keys in all your subsequent requests to the API. Do not generate too many tokens, as we may invalidate your older tokens to make room for newer tokens.
API Overview
Available resources & methods
Where you see params it is a plain Array object, e.g. [email => '[email protected]' ]
Website
-
Website Conversations
- Get Conversation List:
CrispClient->websiteConversations->getList(websiteId, page) - Get A Conversation:
CrispClient->websiteConversations->getOne(websiteId, sessionId) - Get Conversation Metadata:
CrispClient->websiteConversations->getMeta(websiteId, sessionId) - Update Conversation Metadata:
CrispClient->websiteConversations->updateMeta(websiteId, sessionId, params) - Get a Messages in a Conversation:
CrispClient->websiteConversations->getMessages(websiteId, sessionId, query) - Create a Conversation:
CrispClient->websiteConversations->create(websiteId) - Initiate a Conversation:
CrispClient->websiteConversations->initiateOne(websiteId, sessionId) - Send a Conversation:
CrispClient->websiteConversations->sendMessage(websiteId, sessionId, message) - Set Conversation State::
CrispClient->websiteConversations->setState(websiteId, sessionId, state) - Block Conversation::
CrispClient->websiteConversations->setBlock(websiteId, sessionId, blocked) - Delete Conversation::
CrispClient->websiteConversations->deleteOne(websiteId, sessionId) - Acknowledge Messages::
CrispClient->acknowledgeMessages(websiteId, sessionId, fingerprints)
- Get Conversation List:
- Website People (These are your End Users)
The PeopleID argument can be an email or the PeopleID.
- Find By Email:
CrispClient->websitePeople->findByEmail(websiteId, email) - Check By Segments:
CrispClient->websitePeople->findBySegments(websiteId, segments) - Create A New Profile:
CrispClient->websitePeople->createNewPeopleProfile(websiteId, params) - Check If Exists:
CrispClient->websitePeople->checkPeopleProfileExists(websiteId, peopleId) - Get People Profile:
CrispClient->websitePeople->getPeopleProfile(websiteId, peopleId) - List People Profiles:
CrispClient->websitePeople->listPeopleProfiles(websiteId, peopleId, page) - Remove A Profile:
CrispClient->websitePeople->removePeopleProfile(websiteId, peopleId) - Save A Profile:
CrispClient->websitePeople->savePeopleProfile(websiteId, peopleId, params) - Update A Profile:
CrispClient->websitePeople->updatePeopleProfile(websiteId, peopleId, params) - List Conversations
CrispClient->websitePeople->listPeopleConversations(websiteId, peopleId, page) - List Segments:
CrispClient->websitePeople->listPeopleSegments(websiteId, peopleId, page) - List Events:
CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, page) - Add Event:
CrispClient->websitePeople->addPeopleEvent(websiteId, peopleId, event) - Get Data:
CrispClient->websitePeople->getPeopleData(websiteId, peopleId) - Update Data:
CrispClient->websitePeople->updatePeopleData(websiteId, peopleId, params)
- Website Base
- Create A Website:
CrispClient->website->create(params) - Create User Account:
CrispClient->website->delete(websiteId)
- Create A Website:
- Website Settings
- Get Website Settings:
CrispClient->websiteSettings->get(websiteId) - Update Website Settings:
CrispClient->websiteSettings->get(params)
- Get Website Settings:
- Website Verify
- Get Verify Settings:
CrispClient->websiteVerify->getSettings(websiteId) - Update Verify Settings:
CrispClient->websiteVerify->updateSettings(websiteId, params) - Get Verify Key:
CrispClient->websiteVerify->getKey(websiteId) - Roll Key:
CrispClient->websiteVerify->rollKey(websiteId)
- Get Verify Settings:
- Website Operators
- Get All Operators:
CrispClient->websiteOperators->getList(websiteId) - Get One Operators:
CrispClient->websiteOperators->getOne(websiteId, operatorId) - Delete One Operators:
CrispClient->websiteOperators->deleteOne(websiteId, operatorId) - Create An Operator:
CrispClient->websiteOperators->createOne(websiteId, parameters) - Update An Operator:
CrispClient->websiteOperators->updateOne(websiteId, operatorId, parameters)
- Get All Operators:
- Website Visitors
- List Visitors:
CrispClient->websiteVisitors->listVisitors(websiteId, page)
- List Visitors:
Plugins
- Plugin Subscriptions
- List All Active Subsciptions:
CrispClient->pluginSubscriptions->listAllActiveSubscriptions() - Get All Subscriptions For Website:
CrispClient->pluginSubscriptions->listSubscriptionsForWebsite(websiteId) - Get Subscription Details:
CrispClient->pluginSubscriptions->getSubscriptionDetails(websiteId) - Subscribe Website To Plugin:
CrispClient->pluginSubscriptions->subscribeWebsiteToPlugin(websiteId, pluginId) - Unsubscribe Plguin From Website:
CrispClient->pluginSubscriptions->unsubscribePluginFromWebsite(websiteId, pluginId) - Get Subscription Settings:
CrispClient->pluginSubscriptions->getSubscriptionSettings(websiteId, pluginId) - Save Subscription Settings:
CrispClient->pluginSubscriptions->saveSubscriptionSettings(websiteId, pluginId, settings)
- List All Active Subsciptions:
All versions of php-crisp-api with dependencies
PHP Build Version
Package Version
The package ogillot/php-crisp-api contains the following files
Loading the files please wait ....