Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

PPW Link

PPW Link (PPWL) is a web service to allow PPW systems to transfer data between accounts. These accounts can be in the same environment or different environments. This was implemented to support PPW enterprise customers. Can also support any other integrations that would like to use the same processes.

Using your PPW account, login to the system. Go to the Admin > Auto Import - Work Orders page. Click the Setup New Import button in the toolbar. The Import From field should be set to PPW Link - Property Pres Wizard-v2. Set the client company to the desired value. Enter the PPW account username and password. The PPW Link URL should point to the receiver script of your integration.

When the Auto Import record is saved the validate_user event will be called. This event will pass the PPW Link Push URL along with verifying the authentication info is correct.

The remote_site_id is a unique UUID. You should generate a UUID and use this UUID for all responses to PPWL. A unique UUID can be generated at the site GUID Generator

PPWL uses HTTP POST to transfer all data. The basic structure of each request is similar. A single POST variable called “payload” is sent that contains the PPWL data. The contents of the “payload” variable is a JSON encoded string.

The PPWL’s production url is https://www.propertypreswizard.com/api/link/receiver.php

The “payload” fields are as follows

Field NameTypeDescription
usernamestringThe PPW account user name
password stringThe PPW account password
site_iduuidv4The unique site_id. Valid v4 UUID
event_namestringThe event or action being completed.
event_datastringThe main data field. JSON encoded string.

The password is a sha1 hash of the PPW password.

Example call with event data in JSON format. The examples are all shown using the curl program. But any standard HTTP programming interface should work fine.

Request payload JSON

{
  "username": "demo",
  "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
  "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
  "event_name": "ppwl_event_name",
  "event_data": "{}"
}
Curl command line example
curl -X POST \
  --data 'payload={
    "username": "demo",
    "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
    "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
    "event_name": "validate_user",
    "event_data": "{}"
  }' \
  https://www.propertypreswizard.com/api/link/receiver.php

Responses from PPWL will be in the JSON format with the following fields.

Field NameType/LengthDescription
remote_site_id uuidv4The unique site_id.
error booleanTrue or false.
success booleanTrue or false
return_error_msgstringIf error is true, contains error message.
result_data stringThe main data field. JSON encoded string.

Response JSON

{
   "remote_site_id":"1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",
   "error":false,
   "success":true,
   "return_error_msg":null,
   "result_data":null
}

Suggested Data Flow

Data Flow