Download the PHP package riddle/client-sdk without Composer
On this page you can find all versions of the php package riddle/client-sdk. 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 client-sdk
Riddle PHP client
This library makes it easy to work with...
- the Riddle API v3
- incoming Riddle webhooks (validates & parses them)
Available endpoints can be found here.
Installation
To use this library you need to have PHP 7.4 or higher (8.0 / 8.1) installed.
With composer
When working with composer all you need to do is run the following command:
In your .php file you can then include the composer autoloader:
Without composer
To use it without a package manager download this repository, extract it, keep the src/ folder and include the Client.php file in your project:
Authentication
When using the API you need to authenticate yourself with an access token. You can create one in your Riddle account (you must be logged-in to view this page). You can then pass the token to the client:
Now you're ready to use the API.
Example usages
Get all riddles
Get alltime stats for a Riddle (only available for Business & Enterprise plans)
Get riddles from team with tags
Parse webhook
Note: The webhook signature key is not required - if it's not given the signature validation will be skipped.
Build basic Riddles
You can also build Riddles via the API.Please note that this feature is currently in-beta and is expected to be expanded in the future.
Please drop us any feedback you have on this feature via support chat on riddle.com or send us an email @ [email protected]!
To use this feature, create an instance of either PollBuilder or QuizBuilder:
Build a poll
When building a poll you can:
- set the title
- add single choice questions
- add multiple choice questions
- set the single result the user will see at the end of the Riddle
Here's the full code snippet:
Build a quiz
When building a quiz you can:
- set the title
- add single choice questions
- add multiple choice questions
- add as many results as you want, each with a title, description and score range (min/max)
Here's the full code snippet:
Note: Generated Riddles will be automatically published. To disable this you must pass false to the build() method:
Building Riddles with custom result pages (buttons, answered blocks etc)
Build Riddles with forms
You can add "Make a form" blocks to your Riddle. This allows you to collect user data (name, email, phone, etc).
Manipulate the build directly
We are aware that the current builder classes in this SDK do not cover all possibilities of the builder API (there are just too many!).
Therefore, you can also manipulate the build directly:
