API Documentation
SkySlope ¶
Overview
SkySlope is a real estate transaction management software used by real estate agents and brokers. It helps users manage documents, streamline compliance workflows, and track transactions from start to finish
In order to do this, Rechat connects to a third party service called SkySlope.
We want to integrate Deal section with Skyslope to give our members ability to do this workflow in Skyslope and have all signed documents in Rechat deals.
Therefore, in order for Rechat to be able to do anything in this section, the user would have to authenticate with his Skyslope credentials.
Authentication
The process of authenticating a user is as follows:
-
User’s browser will be opened to
/users/self/skyslope/auth -
User’s browser will be redirected to skyslope
-
User logs in and authorizes Rechat
-
User’s browser will be redirected back to Rechat
-
Control is given back to client (either using Browser’s
postMessagemechanism or redirecting him torechat://on phones) -
Client tries again the initial action
Start authentication ¶
Start authenticationGET/users/self/skyslope/auth
Example URI
302Disconnect Skyslope ¶
Get Skyslope forms ¶
Get Skyslope formsGET/users/self/skyslope/forms
start (number) number of rows to skip before starting to return rows
limit (number) limited number of records
You encounter a 428 error. if skyslope is not connected
Example URI
200Body
{
"code": "OK",
"data": [
{
"id": 36095,
"name": "Agreement Notice to Short Sale Addendum (Short Sale)",
"libraryId": 14289,
"attributes": {
"form-type": "BRBC"
},
"source": "Amador County Local Documents - CA",
"type": "skyslope_form"
},
{
"id": 40144,
"name": "BRBC Buyer Representation And Broker Compensation Agreement",
"libraryId": 14289,
"attributes": {
"form-type": "BRBC"
},
"source": "Amador County Local Documents - CA",
"type": "skyslope_form"
}
],
"info": {
"count": 2,
"total": 2
}
}Create skyslope envelope for a checklist ¶
Create skyslope envelope for a checklistPOST/deals/:id/checklists/:cid/skyslope/envelope
You encounter a 428 error. if skyslope is not connected
tasks (string[]) array of taskId
Example URI
- id
string(required) Example: 0996e920-650e-4f57-a3dc-aea33afd18b8- cid
string(required) Example: 70d76894-dd3f-4742-996f-d2150b206a86
Body
{
"tasks": [
"d8a8e5e2-fa0e-47da-ab9e-b1534ca531a9"
]
}200Body
{
"code": "OK",
"data": {
"success": true,
"envelope_id": "envelopeId",
"type": "SKYSLOPE_ENVELOPE",
"taskSyncErrors": {}
}
}