top of page

API Documentation

Business Authentication API:

 

Description: Use this API to authenticate registered business.

 

URL: https://admin.thepronextdoor.com/api/loginZapp

 

Method: POST

 

Headers: 

Content-Type: application/json; charset=utf-8

 

Request Body (JSON): 

{

    'username': <<string>>, -------- (Required field)

    'unique_business_id': <<integer>>, -------- (Required field)

    'password': <<string>> -------- (Required field)

 }

 

Response Body (SUCCESS):

{

  "title": "success",

  "status": true,

  "data": {

    "first_name": "FirstName",

    "last_name": "LastName",

    "role": "owner"

  },

  "message": "Login success."

}

 

Response Body (ERROR):

{

    "title": "error",

    "status": false,

    "data": {},

    "message": "User not found."

}

 

 

 

Get Business Services API (Used in triggers):

 

Description: Use this API to get a service list of registered businesses.

 

URL: https://admin.thepronextdoor.com/api/get_subindustry_list_by_business_id

 

Method: POST

 

Headers: 

Content-Type: application/json; charset=utf-8

 

Request Body (JSON): 

{

    'unique_business_id': <<integer>> -------- (Required field)

 }

 

Response Body (SUCCESS):

[

    {

        "id": "610a9049250c894853c708c5",

        "sample": "Contact to learn more",

        "value": "610a9049250c894853c708c5",

        "label": "Contact to learn more"

    },

    ……..

]


 

Response Body (ERROR):

{

    "status": false,

    "message": "Something went wrong!",

    "data": null,

    "title": "error"

}

 

 

 

Add New Yard Sign API: 

 

Description: Use this API to add new job in registered business.

 

URL: https://admin.thepronextdoor.com/api/addJob

 

Method: POST

 

Headers: 

Content-Type: application/json; charset=utf-8

 

Request Body (JSON): 

{

    'uniqueBusinessId': <<integer>>, -------- (Required field)

    'teamMemberId': <<string>>, -------- (Required field)

    'longitude': <<integer>>, 

    'latitude': <<integer>>,

    'city': <<string>>, -------- (Required field)

    'state': <<string>>, -------- (Required field)

    'country': <<string>>, -------- (Required field)

    'address': <<string>>, -------- (Required field)

    'shortAddress': <<string>>, -------- (Required field)

    'addressPrivate': <<string>>, -------- (Required field)

    'services': <<array>>, -------- (Required field)

    'servicesPrivate': <<boolean>>, -------- (Required field)

    'serviceLocation': <<enum>>, -------- (Required field)

    'serviceLocationPrivate': <<boolean>>, -------- (Required field)

    'featured': <<boolean>>, -------- (Required field)

    'status': <<enum>>, -------- (Required field)

    'statusPrivate': <<boolean>>, -------- (Required field)

    'cost': <<float>>,-------- (Required field)

    'costPrivate': <<boolean>>,-------- (Required field)

    'description': <<string>>,-------- (Required field)

    'descriptionPrivate': <<boolean>>,-------- (Required field)

    'photos': <<array>>,-------- (Required field)

    'documents': <<array>>,-------- (Required field)

    'videos': <<array>>,-------- (Required field)

    'jobPrivate': <<boolean>>-------- (Required field)

 }

 

Response Body (SUCCESS):

{

    "status": true,

    "message": "Job details saved successfully",

    "data": {

………..

}

    "title": "success"

}

 


 

Response Body (ERROR):

{

    "status": false,

    "message": "Something went wrong!",

    "data": null,

    "title": "error"

}

 

 

Sample Request Body: 

{

    "uniqueBusinessId": 885885674,

    "teamMemberId": "60583b07363fe72c239d54f8",

    "longitude": -72.090093,

    "latitude": 49.203,

    "city": "New York City",

    "state": "New York",

    "country": "US",

    "address": "302, New York",

    "shortAddress": "302 NY",

    "addressPrivate": true,

    "services": [

        "60583a83363fe72c239d54ee"

    ],

    "servicesPrivate": true,

    "serviceLocation": "My Business Location",

    "serviceLocationPrivate": true,

    "featured": false,

    "status": "Completed",

    "statusPrivate": true,

    "cost": 50,

    "costPrivate": true,

    "description": "This is description of a job",

    "descriptionPrivate": true,

    "photos": [

            "https://image.jpeg",

            "https://image.jpeg"

    ],

    "documents": [

"https://document.pdf",

              "https://document.pdf"

    ],

    "videos": [

              "https://video.mp4",

              "https://video.mp4"

    ],

    "jobPrivate": true

}

bottom of page