Page tree
Skip to end of metadata
Go to start of metadata

The data downloaded by API should be saved to a local database. Web pages should display data from database prepared in that way.

Number of queries to the API is restricted to 25 per minute (It's best to use a 3-4 second interval). Limit of connection can undergo change.


 

Introduction

Api methods serve http calls responding with json (http://www.json.org/)

Authentication via Cookie

To autheniticate you need login and password

https://api.asari.pro/login/authenticate

Parameter:

ParameterFormat
emailstring
passwordstring

Authentication example

curl --request POST -H "Content-Type=multipart/form-data" -d "email=<email>&password=<password>" -c cookieFile URL

apiSITE


Response format

Every response object has property:

  • success (boolean) - determaining if response is valid or error occured.

Success Response

Json object with properties:

  • data (object or array of objects)
  • totalCount (integer) - returned if data is array and method enables pagination

Example simple object:

{
  success: true
  data: {
    id: 1
    propertyType: "House"
  }
}

Example list:

{
  success: true,
  data: [
    { id: 1, propertyType: "House"},
    { id: 2, propertyType: "Lot"},
    { id: 3, propertyType: "House"},
  ],
  totalCount: 140
}

Error Response

Json object with properties:

  • error (string) - error message in human readable format (localized)
  • parametersErrors (object where properties are names of parameters and values are error messages related to given parameter) - returned if error is related to input parameters. F.ex. can be used as error messages for forms submitted by user.

Example error:

{
  success: false,
  error: "You need to activate asariCRM to add tasks"
}

Example error with parameter errors:

{
  success: false,
  error: "Invalid input",
  parameterErrors : {
    email: "Invalid format",
    password: "Password to short"
  }
}

Return types

Method will return json object with following properties (more info http://www.json.org/ )

Type

Format

Example

string

text

"bla bla bla"

integer

number

3242

float

decimal part separated by period

3232.3232

date

text in format yyyy-MM-dd hh:mm:ss

"2010-12-31 18:55:58"

boolean

true, false


money

object

{ amount: (float),currency:(string)}
{ amount: 251 currency:"PLN"}

Dictionaries

Name

Values

fieldType

string, integer, float, date, boolean, money, dictionary, dictionaryList

view

show, edit, list, search

section

ApartmentSale, ApartmentRental, HouseSale, HouseRental, LotSale, LotRental, CommercialSpaceSale, CommercialSpaceRental, CommercialObjectSale, CommercialObjectRental, Investment, RoomRental

status

Active, Cancelled, Closed, Pending, Draft

taskStatus

Waiting, Solved, Cancelled

taskType

Regular, Event, Reminder, Appointment, Call

callTypeOUTGOING, INCOMING, MISSED, REJECTED

listingActivityEventType

Appointment, ContactAcquisition, Email, Printout

seekerActivityEventType

Appointment, ContactAcquisition, Email

seekerPrivilege

Contact, PublicContact, Edit, Related

listingPrivilege

Contact, PublicContact, Edit, Related

contractType

Exclusive, Open, None, Direct, CustomerApplication

ownershipType

Mortgage, HousingCooperative, Shared, Other

currency

PLN, EUR, USD

customerType

Person, Company

customerFrom

Press, Internet, Phone, DirectVisit, Command

commissionPercentPeriod

Year, Month

valueType

String, Integer, Float, Date, Boolean, Dictionary, DictionaryList

scopeAll , Company,  Swo, Office
conditionPerfect, VeryGood, Good, NeedsSmallRenovation, NeedsTotalRenovation, NeedsConversion, NeedsFinishing, OpenRawState, CloseRawState

Methods

  • Required paremeters are marked with *
  • If property is type of dictionary and both names are the same, name of dictionary is ommited f.ex. - sectionName(dictionary SectionName) -> sectionName(dictionary)
  • Methods that raturn that don't return no data except of success indicator are marked as succces/failure
  • No labels