Download the PHP package forward-force/workiz without Composer

On this page you can find all versions of the php package forward-force/workiz. 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:
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.
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?

Example code of forward-force/workiz

Informations about the package workiz

Workiz API - PHP SDK

This is a wrapper around Workiz API. The API is very minimal, so this implementation is fairly simple.

Authentication

In order to authenticate you need a token from Workiz. Head over to the developer portal to read updated procesure as how to obtain one: https://developer.workiz.com/

Workiz is likely to give you a toke and a secret, the API requires the token only.

Jobs API

You can get all jobs via paginated list or a single job.

How to get all jobs:

The example above will give you the first N number of jobs. N is the size of the page, set to 10 by default.

How to change the page size or paginate:

The example above illustrate how to change the page size (by using take()) and how to change the offset (by using skip()). Therefore, the example above will take 25 records starting from the 10th record (skipping the first 10).

How to get a single job:

The example above illustrates how to get a single job by its uuid.

How to pass additional query parameters to the API:

The example above illustrates how to get only pending jobs. There are other helper methods as well such as getQueryString, resetQueryParameters, removeQueryParameter, which may nor may not be useful.

Leads API

You can get all leads via paginated list or a single lead.

How to get all leads:

The example above will give you the first N number of leads. N is the size of the page, set to 10 by default.

How to change the page size or paginate:

The example above illustrate how to change the page size (by using take()) and how to change the offset (by using skip()). Therefore, the example above will take 25 records starting from the 10th record (skipping the first 10).

How to get a single lead:

The example above illustrates how to get a single lead by its uuid.

Time Off API

You can get all timeOffs via paginated list or a single timeOff.

How to get all timeOffs:

The example above will give you the first N number of timeOffs. N is the size of the page, set to 10 by default.

How to change the page size or paginate:

The example above illustrate how to change the page size (by using take()) and how to change the offset (by using skip()). Therefore, the example above will take 25 records starting from the 10th record (skipping the first 10).

How to get a single timeOff:

The example above illustrates how to get a single timeOff by its uuid.

Contributions

To run locally, you can use the docker container provided here. You can run it like so:

Then you can ssh into the php-fpm container. Please note, you need to set your WORKIZ API key and SECRET as environmental variables $WORKIZ_TOKEN and $WORKIZ_SECRET respectively. However, the secret is not needed at this time you could set it to anything.

xdebug is fully configured to work as cli, hookup your favorite IDE to it and debug away!

There is auto-generated documentation as to how to run this library on local, please take a look at phpdocker/README.md

If you find an issue, have a question, or a suggestion, please don't hesitate to open a github issue.

Acknowledgments

Thank you to phpdocker.io for making getting PHP environments effortless!

All versions of workiz with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4
ext-json Version *
guzzlehttp/guzzle Version ^7.1@dev
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package forward-force/workiz contains the following files

Loading the files please wait ....