Download the PHP package opendns/autotask-php without Composer
On this page you can find all versions of the php package opendns/autotask-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package autotask-php
This library is not actively maintained or monitored.
Introduction
autotask-php is designed to make it easier to interact with the Autotask Web Services API by providing interfaces that actually match the official documentation.
All objects that are exposed by Autotask have wrapper classes
located in the src/AutotaskObjects
folder.
If you find any bugs, or have feature requests, please file an issue in GitHub or open a pull request.
This client is under active development, and therefore has no stable version.
Installation
Composer
Ensure that composer is installed on your machine.
You will need to create a composer.json
file in the root
directory of your application.
Once the composer.json
file is created, follow these steps
from composer to install the autotask-php package.
Composer creates its own autoloader. Include
vendor/autoload.php
in your application config file and
you will have full access to the autotask-php client.
Manual
- download the zip or clone the git repo from GitHub
- if necessary, extract the zip to your desired location
- add a call to include
src/autoload.php
to get access to the Client.
Usage
Supports both current versions of the Autotask's API; v1.6 and v1.5.
Version 1.6
Starting with version 1.6, Autotask only allows 'API User' type and all calls must include an integration code in the header. Please refer to Autotask's Web Services documentation in Autotask's help center for setting up the API User account and generating the integration code.
You can set your WSDL file or use the auto detect (https://webservices.autotask.net/atservices/1.6/atws.wsdl)
You can set the integration code with you instantiate your client or after the fact. On every API call, the client will check if the version is 1.6 and confirm the integration code is set (except on getZoneInfo()). If one is not found, it will throw and error.
Fetch your zone WSDL and setting your integration code (instantiation process)
Fetch your zone WSDL then setting your integration code
Version 1.5
Any Autotask user account with the 'Can login to Web Services API' permission can connect via this version of the API.
You can set your WSDL file or use the auto detect (https://webservices.autotask.net/atservices/1.5/atws.wsdl)
Fetch your zone WSDL
Resource Impersonation
Your API-only user can impersonate resources on Account Notes, Contract Notes, Project Notes, Task Notes, Ticket Notes, and Time Entries. So, when notes and time entries are added to Autotask by users using an integration with Autotask, the user's name (not the API user's) appears as the author.
Requirements
- Integration users need to provide the
tag in the AutotaskIntegrations SOAP header. - Both the integration user and the API-only user must have security level permission to add or edit the time entry.
- The integration user's security level must allow the resource to be impersonated.
- The API-only user's security level must allow impersonation on the entity type.
For more details on impersonation security levels, refer to Resource Impersonation.
When calling the setResourceImpersonation() method. It will replace the existing SOAP header with the integration code and the resource to impersonation. Allowing you to change the resource impersonation without the need of instantiating a new client.
When the instantiating the client, if you did not include the integration code and you call the setResourceImpersonation() method, it would throw an error 'Integration code required when using resource impersonation.' To resolve, call method setIntegrationCode('27-character ID') to set the integration code then you can call setResourceImpersonation().
Or you can call the setResourceImpersonation() method then call create() or update().
Search Contacts
More Detailed Queries
We have provided support for some of the more detailed
queries that you may need to execute. A given query can have
multiple QueryField
objects and a given QueryField
can
have multple QueryFieldExpression
objects.
Really Detailed Queries
Need access to extremely detailed queries that involce using
Conditions? Support for condition queries have been added to
the autotask-php client. The important thing to note when
using conditions is that order matters. Any QueryCondition
or QueryField
added will be serialized to XML in that order.
QueryCondition
objects can include other QueryCondition
objects, as well as QueryField
objects. The example below
attempts to showcase the possibilities of using a
QueryCondition
object.
Since the above example is so complex, we have included the "SQL Equivalent" conditional, and the XML that is produced by the Client.