All Collections
Developer API's
Sync API - Postman Samples
Sync API - Postman Samples

A collection of JSON calls to get developers started

Dillon avatar
Written by Dillon
Updated over a week ago

Client will receive details on a Sync API sandbox account, and is supplied with a set of master account credentials.

Following is an example of the credentials you will receive:

Username: ET Property Sandbox

Password: c4bd2ed2-0292-4070-9631-a4ee380f7612

SourceId: 77

Endpoint for both sandbox and live environments: https://sync.entegral.net/api/

Documentation: https://api.entegral.net/SyncAPI.html#/

NB: The master ApiUserName and ApiKey keys we provide is only used to create new keys for the office you want to create.

1st step is to use the master keys and call https://api.entegral.net/SyncAPI.html#/operations/CreateOfficeCredentials to create keys for your office.

New keys are returned in the response and can then be used to create the actual office, then agents and then listings (https://api.entegral.net/SyncAPI.html#/operations/CreateaOffice)

Creating Credentials Samples:

Creating the Office Samples:

The returned keys are now used to authenticate and create your office (and these keys will further be used to authenticate for making agent and listing requests, the master credentials we supplied is not used for any further calls)

Here is the complete payload of the office creation request example:

{
"clientOfficeID":"5678",
   "portalOffice":[
      {
         "name":"flex"
      }
   ],
   "clientGroup":[
      {
         "name":"ET Property",
         "id":"1"
      }
   ],
   "name":"ET Property",
   "country":"South Africa",
   "tel":"0115559999",
   "fax":"0825559999",
   "email":"joe@etproperty.co.za",
   "profile":"bla bla bla",
   "postalAddress":"Postnet Suite 5555\\nPrivate bag X777\\nHorison\\n0022",
   "physicalAddress":"\\nHorison",
   "website":"https://www.etproperty.co.za/",
   "action":"create",
   "logo":"https://image-server.etproperty.co.za/estate_agent/logo/2224.gif",
   "timestamp":"2021/07/02 09:03:15 PM"
}

Creating an Agent Sample:

Complete payload of the Agent creation request example:

{
  "clientAgentID": "1234",
  "clientOfficeID": "5678",
  "portalAgent": [
    {
      "name": "flex"
    }
  ],
  "fullName": "Joe",
  "lastName": "Doe",
  "role": "Manager",
  "cell": "0825559999",
  "email": "joe@etproperty.co.za",
  "officeTel": "0115559999",
  "officeEmail": "info@etproperty.co.za",
  "profile": "We sell Properties",
  "socialMediaLinks": {
    "twitter": "twitprofile", 
    "facebook": "facebooklink", 
    "linkedin": "linkedinlink", 
    "instagram": "instalink", 
    "skype": "skypeName"
  },
  "action": "create",
  "photo": "https://image-server.etproperty.co.za/123_123.jpg",
  "timeStamp": "2021/07/02 20:14"
}

Create a Listing Sample:

Complete payload of Listing example:

{
    "clientPropertyID" : "91011",
    "currency" : "ZAR",
    "price" : 800000,
    "ratesAndTaxes" : 0,
    "levy" : 0,
    "landSize" : 200,
    "landSizeType" : "m2",
    "buildingSize" : 150,
    "buildingSizeType" : "m2",
    "propertyType" : "House",
    "propertyStatus" : "For Sale",
    "country" : "South Africa",
    "province" : "Gauteng",
    "town": "Pretoria", 
    "suburb" : "Garsfontein",
    "beds": 2,
    "bedroomFeatures" : "-",
    "baths" : 1.5,
    "bathroomFeatures" : "-",
    "securityFeatures": "",
    "gardenFeatures": "",
    "kitchenFeatures": "",
    "pool" : "1",
    "listDate" : "2021/07/03 10:34:35",
    "expiryDate" : "2022/07/03 10:34:35",
    "study" : 1,
    "livingAreas" : 2,
    "staffAccommodation" : 1,
    "petsAllowed" : "0",
    "carports" : 2,
    "openparking" : 0,
    "garages" : 2,
    "photos" : 
        [
            {
                "imgUrl" : "https://imgage-server.etproperty.co.za/1.jpg",
                "imgDescription" : "bathrooms"
            },
            {
                "imgUrl" : "https://imgage-server.etproperty.co.za/2.jpg",
                "imgDescription" : "bedrooms"
            }
        ],
    "propertyFeatures" : "-",
    "streetNumber" : "124",
    "streetName" : "Julian Str",
    "unitNumber" : 0,
    "flatLet" : "1",
    "complexName" : "-",
    "latlng" : "0,0",
    "showOnMap" : "0",
    "description" : "this is a property description",
    "isReduced" : "1",
    "vtUrl":"",
    "isDevelopment" : "0",
    "mandate" : "Open",
    "contact":
    [
        {
            "clientAgentID": "1234",
            "clientOfficeID" : "5678",
            "fullName": "Joe Doe",
            "cell": "0825559999",
            "email": "joe@etproperty.co.za",
            "profile": "We sell Properties",
            "logo": "https://www.etproperty.co.za/123_123.jpg"
        }
    ],
    "portalListing": 
    [
       {
        "name": "flex",
        "id": "91011"
       }
    ],
    "onshow" : 
        [
            {
                "dateStart" : "2021/07/06 15:00:00",
                "dateEnd" : "2021/07/06 16:00:00",
                "description" : "folllow boards"
            }
        ],
    "files" : 
        [
            {
                "url" : "https://file-server.etproperty.co.za/files/file1.pdf",
                "description" : "Virtual Tour",
                "type" : "file",
                "id" : "112233"
            },
            {
                "url" : "https://file-server.etproperty.co.za/preview.html",
                "description" : "Link to my other page",
                "type" : "link",
                "id" : "BC589475"
            }
        ],
    "action" : "create",
    "timeStamp" : "2021/07/03 20:14"
}

* Note: There is no need to set any key values for Params or Headers, can simply use Basic Auth Type as Authorization method, and use raw JSON to send your Body request.

References:

Did this answer your question?