Download the PHP package setka/workflow-php-sdk without Composer
On this page you can find all versions of the php package setka/workflow-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download setka/workflow-php-sdk
More information about setka/workflow-php-sdk
Files in setka/workflow-php-sdk
Package workflow-php-sdk
Short Description SDK for communicating with Workflow service.
License GPL-2.0-or-later
Informations about the package workflow-php-sdk
Setka Workflow PHP SDK
The library is developed to simplify your interaction with Workflow API. With Workflow API, you can update ticket information and manage post categories.
Guzzle is used to send HTTP requests. You can use any available handler with Guzzle, including cURL, Stream, etc., or create your own.
Basics
To start, install the library into your project using Composer Dependency Manager (the library is not yet registered at packagist.org, but we’re working on it!). In order to execute composer require
you have to:
-
Open the
composer.json
file and specify therepository
field and the following information: - Execute the
composer require
command from your project directory.
How do I start working with Workflow API?
An API license key is required for sending requests. Copy your API License Key from "Account Settings":
- Log in your Workflow account workflow.setka.io.
- Go "Settings" at the right hand upper corner.
- Click "Custom CMS" and copy an API license key.
Sending your First Request to Setka Workflow API
First, initialize these objects to send requests:
Setka\WorkflowSDK\API
— a main object for API interaction.GuzzleHttp\Client
— sends HTTP-requests using the chosen Handler.Setka\WorkflowSDK\AuthCredits
— stores data required for Workflow API authentication (API license token).
Setka\WorkflowSDK\Actions\ActionInterface
— any class with this interface is set for sending appropriate requests to the API.
Creating a Category
Once you’ve performed your first request, you can save "Space Short Name" as a parameter for sending future requests. "Space Short Name" is used almost in all requests so we recommend that you cache the "GetSpaceAction" response for better performance.
Contributing
To run PHP Code Sniffer run the following commands.