Download the PHP package brianfreytag/ultipro-sdk-php without Composer

On this page you can find all versions of the php package brianfreytag/ultipro-sdk-php. 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 brianfreytag/ultipro-sdk-php

Informations about the package ultipro-sdk-php

Ultipro SDK for PHP (Unofficial)

Latest Stable Version Total Downloads

This is an unofficial library to allow seamless connections to Ultipro's REST API via PHP.

This library was created because Ultimate Software does not have any SDK and none of their documentation lays out how to use PHP for any of it.

Installation

Usage

Authentication

You can authenticate in the Client in one of two ways: 1) Authentication Object, 2) Array

Authentication Object:

Array:

Client Arguments

The client takes three arguments: 1) $auth - Authentication (see above) 2) $baseURi - Found in Ultipro -> Configuration -> Security -> Web Services (Defaults to https://service5.ultipro.com) 3) $options - Guzzle Request Options to overwrite defaults (http://docs.guzzlephp.org/en/stable/request-options.html)

Choosing a Client

You can use the default UltiproClient to manually do GET and POST requests, or you can utilize alternate clients for each Ultipro API endpoint "groups". This version includes clients for the following endpoints:

For endpoints with PERSONNEL, use the PersonnelClient. For the endpoints with CONFIG use the ConfigurationClient.

Using a Client

For Personnel queries, utilize the Ultipro\Personnel\PersonnelClient client.

Each client method accepts a Request object that implements the RequestInterface interface.

The RequestInterface receives query parameters from classes that extend the base Query. Nearly every endpoint accepts different query parameters, so under the various endpoint namespaces, there are different *Query classes under the Query directory that will accept different data to search the endpoints.

Here is a simple example of pulling Person Detail API data utilizing an Employee ID (as defined from Ultipro):

Todo

There is still a lot of work to do in this library, including many endpoints to implement.

Configuration

Personnel

Onboarding

Simple Schedule

Time

Other Items

All versions of ultipro-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
guzzlehttp/guzzle Version ^6.3
guzzlehttp/psr7 Version ^1.5
guzzlehttp/promises Version ^1.3
ext-pcre Version *
ext-json Version *
ext-xml Version *
symfony/property-info Version ~3.4|~4.0|~5.0
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 brianfreytag/ultipro-sdk-php contains the following files

Loading the files please wait ....