Skip to content

Latest commit

 

History

History
145 lines (116 loc) · 5.15 KB

README.md

File metadata and controls

145 lines (116 loc) · 5.15 KB
Raw

Fireberry by Powerlink RestAPI

This is an up to date wrapper for the Powerlink.co.il REST API. we initially found working with the API to be a bit frustrating and hopefully this wrapper will make everything easy for you.

More information about the Powerlink REST API can be found at

https://support.powerlink.co.il/support/kb/%D7%94%D7%AA%D7%9E%D7%9E%D7%A9%D7%A7%D7%95%D7%99%D7%95%D7%AA/Rest_API

Please email support@fireberry.com if you find any bugs.

index

Authentication

To make a REST API call, you must include request headers including the Authorization header ==> Find your TOKENID

Create

URL:

https://api.powerlink.co.il/api/record/{ObjectType}

Method:

POST

Json exemple:

{
 "accountname" : "משה",
 "telephone1" : "036339060",
 "idnumber" : "1234",
 "billingcity" : "תל אביב"
}

More exemple in PHP | python | ASP.NET |

Update

URL:

https://api.powerlink.co.il/api/record/{ObjectType}/{id}

Method:

PUT

Json exemple:

{
 "accountname" : "משה",
 "telephone1" : "036339060",
 "idnumber" : "56789",
 "billingcity" : "ירושלים"
}

More exemple in PHP | python | ASP.NET |

Delete

URL:

https://api.powerlink.co.il/api/record/{ObjectType}/{id}

Method:

DELETE

More exemple in PHP | python | ASP.NET |

Query

URL:

https://api.powerlink.co.il/api/query

Method:

POST

Json exemple:

{
"objecttype": 1,
"page_size": 50,
"page_number": 1,
"fields": "accountname,idnumber,telephone1",
"query": "(idnumber  = 12345678) AND (telephone1 = 036339060)",
"sort_by": "accountname",
"sort_type": "desc"
}

More exemple in PHP | python | ASP.NET |

Field Description exemple
objecttype the number of object Account=1, Contact=2,Cases=5 (See more..)
page_size the number of result per page Min:1 Max:500
page_number the page of result start at: 1
fields which fields to show on result for all field: *
query the query you want search ((idnumber = 1234) AND (idnumber = 5678))
sort_by Select field to sort by accountname/idnumber/telephone1
sort_type Select type to sort desc/asc

Type of query:

Operator Description exemple
= find result equal "query": "(idnumber = 1234)"
!= find result not equal "query": "(idnumber != 1234)"
> Greater than "query": "(age1 > age2)"
< Less than "query": "(age1 < age2)"
<= Greater than or equal to "query": "(age1 <= age2)"
>= Less than or equal to "query": "(age1 >= age2)"
OR performs a logical-OR of its bool operands "query": "((idnumber = 1234) OR (idnumber = 456789))"
AND performs a logical-AND of its bool "query": "((idnumber = 1234) AND (accountname = 'משה'))"
is-null look for NULL values "query": "(idnumber is-null 1234567)"
is-not-null look for not NULL values "query": "(idnumber is-not-null 1234567)"
start-with find if the string start with the string "query": "(idnumber start-with 1234567)"
end-with find if the string end with the string "query": "(idnumber end-with 1234567)"
not-start-with find if the string not start with the string "query": "(idnumber not-start-with 1234567)"
not-end-with find if the string not end with the string "query": "(idnumber not-end-with 1234567)"

You can combining the AND and OR Conditions

Note

  • AND & OR conditions allow you to test multiple conditions.
  • Don't forget the order of operation parentheses!

Go to your Powerlink account and let's start!