YourPorter API Documentation

Instructions:

  • Document will have portal, plugin settings, each, and everything to setup
  • The basic setup instructions for each PMS, any settings to amend in the portal, what is pulled, what can be changed, any maintenance, etc.
  • In a word format and tom can then create it on site as a docs
  • We might need to use screenshots as well

Index:

  • Introduction
  • Portal 
  • Add Listings 
  • Add Calendar / Availability
  • Add Reservations
  • Cancel Reservations
  • API Integration
  • Credentials Required 
  • Endpoints 
    • All listings 
    • Single listing 
    • Reservations (Create/Cancel) 
    • Prices (Extra guest fee, daily price, Taxes, Discounts)
    • Availability (Min stay, Available)
  • Missing Endpoints
  • Manual sync all or single listing
  • Auto Sync settings
  • Website Settings
  • Plugin Settings 
    • Overriding 
    • Cronjobs (Enable/Disable)
  • Customization 
  • Auto Registration 
    • Path of files for custom code.
  • Gateways
  • Stripe
  • Options on theme settings
  • Path of files for custom code.
  • Code
  • Child Theme.
  • API Plugin.

1. Introduction 

Your Porter API

Your Porter App is a great tool to manage everyday work! Having all the information stored in one place is such a time saver. Moreover, the synchronization of calendars in real-time is beyond great.

2. Portal 

Add Listings

Add Calendar / Availability

Add Reservations

Cancel Reservations

  1. Reservation can be cancelled by clicking on delete reservation button.

  1. For Authorization token need to contact with Your Porter support after that it will be provided for getting responses from all endpoints.


3. API Integration 

Credentials Required

  1. Authorization Token

Authorization token is required for getting response of all requests.

Endpoints

API Doc: https://documenter.getpostman.com/view/3446982/T17Dgp9t#intro

  1. GET Listings https://api.yourporter.com/external/v1/listings/getAll
  1. GET Single Listing 

https://api.yourporter.com/external/v1/listings/get?listing_id=2f5c2804-c724-4b1f-b6a7-de97b730f969

  1. GET Prices & Availability

https://api.yourporter.com/external/v1/rates?listing_id=2f5c2804-c724-4b1f-b6a7-de97b730f969&start_date=2020-12-01&end_date=2020-12-03


Missing data

  1. No listing Description
  2. No listing Photos
  3. No listing Amenities
  4. No Property Type
  5. No create reservation endpoint
  6. No cancel reservation endpoint

Manual sync options 

  1. All Data sync 

  1. Single listing sync (Go single listing edit page)

Auto Sync Settings

  1. Plugin Setting page (Go to Listings > Settings)
  2. View existing auto schedules 
  3. Can enable/Disable each auto sync by clicking checkbox under Action Column. 


4. Website Settings

Plugin Settings

  1. Plugin Setting page (Go to Listings > Settings)
  2. Enter required API credentials 

  1. Override options
  2. You can enable / disable override settings for API data.

  1. Can view and enable/disable Auto Syncs. 


5. Customization

Auto Registration

Changes for auto registrations module are in following files. 

  1. homey-child\template-parts\boostly-modal-register.php
  2. homey-child\template-parts\instance-booking\nightly.php
  3. plugin\your-porter\assets\js\your-porter.js
  4. plugin\your-porter\your-porter.php

6. Gateways

Stripe 

Changes regarding stripe to Your Porter reservation are in the following files.

  1. theme\homey-child\template-parts\instance-booking\nightly.php
  2. plugin\your-porter\your-porter.php
  3. plugin\your-porter\assets\js\your-porter.js
  4. plugin\your-porter\classes\class-stripe.php

Homey theme settings to enable / disable Stripe gateway



7. Code

Child Theme

Path: theme\homey-child

API Plugin

Path: plugin\your-porter

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us