README

Welcome to the official Syncro API Docs. To use these docs, you will need an active Syncro account. You can sign up for one here: Syncro If you already have an active account, fill in your subdomain below and then click "Authorize" and fill in your api-key. The key is specific to your user account so it is found on the your user profile page. Please review the API License Agreement before using our API. By accessing our API, you are agreeing to the API License Agreement. Please note there is a rate limit of 180 requests per minute per IP address on API Usage.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: v1
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit https://help.syncromsp.com/

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/ecrocombe/syncroMSP_PHPclient.git"
    }
  ],
  "require": {
    "ecrocombe/syncromsp_phpclient": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\AppointmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$date_from = new \DateTime("2013-10-20"); // \DateTime | Returns Appointments that start after the date. Example \"2019-01-25\"
$date_to = new \DateTime("2013-10-20"); // \DateTime | Returns Appointments that start before the date. Example \"2019-12-31\"
$mine = true; // bool | Return only current user's appointments
$page = 56; // int | Returns provided page of results, each 'page' contains 25 results

try {
    $apiInstance->appointmentsGet($date_from, $date_to, $mine, $page);
} catch (Exception $e) {
    echo 'Exception when calling AppointmentApi->appointmentsGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\AppointmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 

try {
    $apiInstance->appointmentsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling AppointmentApi->appointmentsIdDelete: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\AppointmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 

try {
    $result = $apiInstance->appointmentsIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppointmentApi->appointmentsIdGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\AppointmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 
$body = new \VereTech\SyncroMSP_PHPclient\Client\Model\AppointmentsIdBody(); // \VereTech\SyncroMSP_PHPclient\Client\Model\AppointmentsIdBody | Appointment object that needs to be added

try {
    $apiInstance->appointmentsIdPut($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling AppointmentApi->appointmentsIdPut: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\AppointmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \VereTech\SyncroMSP_PHPclient\Client\Model\AppointmentsBody(); // \VereTech\SyncroMSP_PHPclient\Client\Model\AppointmentsBody | Appointment object that needs to be added

try {
    $apiInstance->appointmentsPost($body);
} catch (Exception $e) {
    echo 'Exception when calling AppointmentApi->appointmentsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://{subdomain}.syncromsp.com/api/v1

Documentation For Models

• AppointmentTypesBody
• AppointmentTypesIdBody
• AppointmentsBody
• AppointmentsIdBody
• ContactsBody
• ContactsIdBody
• ContractsBody
• ContractsIdBody
• CustomerAssetsBody
• CustomerAssetsIdBody
• CustomerIdPaymentProfilesBody
• EstimatesBody
• EstimatesIdBody
• EstimatesLineItems
• IdAddLineItemBody
• IdCommentBody
• IdCreatePoLineItemBody
• IdDeleteAttachmentBody
• IdLocationQuantitiesBody
• IdProcessFormBody
• IdReceiveBody
• IdRemoveLineItemBody
• IdTimerEntryBody
• IdUpdateLineItemBody
• IdUpdateTimerEntryBody
• InlineResponse200
• InlineResponse2001
• InlineResponse2001Properties
• InlineResponse2002
• InlineResponse2003
• InlineResponse2003Customer
• InlineResponse2003CustomerContacts
• InlineResponse2003LineItems
• InlineResponse2004
• InlineResponse2004ProductSerials
• InlineResponse2005
• InlineResponse2005Vendor
• InlineResponse2006
• InlineResponse2006WikiPage
• InlineResponse200Customer
• InvoicesBody
• InvoicesIdBody
• InvoicesLineItems
• LeadsBody
• LeadsIdBody
• NewTicketFormsidprocessFormAppointments
• NewTicketFormsidprocessFormCustomerDetails
• NewTicketFormsidprocessFormTicketDetails
• OtpLoginBody
• PaymentProfilesIdBody
• PaymentsBody
• PortalUsersCreateInvitationBody
• ProductIdProductSerialsBody
• ProductSerialsAttachToLineItemBody
• ProductSerialsIdBody
• ProductsBody
• ProductsIdBody
• ProductsProductSkusAttributes
• ProductsidProductSkusAttributes
• PurchaseOrdersBody
• RmmAlertsBody
• RmmAlertsProperties
• TicketIdWorksheetResultsBody
• TicketsticketIdworksheetResultsidAnswers
• TimelogsBody
• UserDevicesBody
• UserDevicesIdBody
• WikiPagesBody
• WikiPagesIdBody
• WorksheetResultsIdBody

Documentation For Authorization

bearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

help@syncromsp.com