9,514
edits
Changes
no edit summary
===Authentication===
===Authentication===
Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getToken|getToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Plugins' link and select [[Plugins#API|API plugin]] 'Settings'.
Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getToken|getToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.
== Methods ==
== Methods ==
create batch booking you can specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one
create batch booking you can specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one
parameter can be specified). You should specify an <code>$additionalFields</code> parameter if service requires
parameter can be specified). You should specify an <code>$additionalFields</code> parameter if service requires
some additional fields (see [[Plugins#Additional fields|Additional fields plugin]]). To create a booking with promo code you
some additional fields (see [[Custom_Features#Additional_Fields|Additional fields Custom feature]]). To create a booking with promo code you
should pass it as additional field. For example: <code>{"name": "promocode", "value": "some code", "type": "text"}</code>See [[#book response|example]] of <code>book</code> API method response.
should pass it as additional field. For example: <code>{"name": "promocode", "value": "some code", "type": "text"}</code>See [[#book response|example]] of <code>book</code> API method response.
Returns Array.
Returns Array.
Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location plugin.
Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom feature.
Returns empty array if all units are not allowed.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>
Eg.: <code>[1, 2, 3]</code>
Returns Array.
Returns Array.
Return additional fields for certain event if [[Plugins#Additional_fields|Additional fields plugin]] is
Return additional fields for certain event if [[Custom_Features#Additional_Fields|Additional fields Custom feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' plugin activated.
API method to check if 'event_field' Custom Feature activated.
Returns Object|null.
Returns Object|null.
Returns information about [[Plugins#Any_Employee_selector|Any Employee selector plugin]] configuration. Returns
Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee Selector Custom Feature]] configuration. Returns
null if plugin not enabled.Example:
null if Custom Feature not enabled.Example:
{
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"description" : "Select this option, if you want to find an available time with any of the employees",
Returns Array.
Returns Array.
Returns company categories list if [[Plugins#Service categories|Service categories plugin]] is activated. Returns
Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if plugin is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if plugin activated.
API method to check if Custom Feature activated.
Returns Array.
Returns Array.
Returns available locations for company if plugin [[Plugins#Unit location|Unit location plugin]] is activated. Return
Returns available locations for company if Custom Feature [[Custom_Features#Unit_Location|Unit location Custom Feature]] is activated. Return
an error with code -32001 if plugin is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if plugin activated.
API method to check if Custom Feature activated.
This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
Returns an object with detailed information about promotion by promotion code. You can get promotion code
Returns an object with detailed information about promotion by promotion code. You can get promotion code
using <code>[[Catalogue#getPromotionList|getPromotionList]]</code> API method. If promotion record with specified
using <code>[[Catalogue#getPromotionList|getPromotionList]]</code> API method. If promotion record with specified
code not found then method returns an empty array (an empty object). If [[Plugins#Simply Smart Promotions|Simply Smart Promotions plugin]]
code not found then method returns an empty array (an empty object). If [[Custom_Features#Simply_Smart_Promotions|Simply Smart Promotions Custom Feature]]
not enabled then method returns an error with code -32001 (Plugin is not activated). Use
not enabled then method returns an error with code -32001 (Custom Feature is not activated). Use
<code>[[#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if plugin enabled.See [[#getPromotionList response|example]] of <code>getPromotionList</code> API method response. Please note that
<code>[[#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if Custom Feature enabled.See [[#getPromotionList response|example]] of <code>getPromotionList</code> API method response. Please note that
response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).
response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).
Returns Array.
Returns Array.
Return plugin status true if status active, else false. See [[#Plugin's identifiers|list of available plugin's names]].
Return Custom Feature status true if status active, else false. See [[#Plugin's identifiers|list of available Custom Feature's names]].
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Plugins#Google calendar sync plugin|Google calendar sync plugin]] enabled then object with
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Google_Calendar_Sync|Google calendar sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Google
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Google
calendar sync plugin activated.
calendar sync Custom Feature activated.
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>
If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
units available only for selected location. See [[Custom_Features#Unit_Location|Unit Location]] Custom Feature description for
more details.
more details.
Returns String.
Returns String.
Returns user license text if user license plugin is turned on,
Returns user license text if user license Custom Feature is turned on,
otherwise throws exception
otherwise throws exception
Returns Boolean.
Returns Boolean.
Returns true if [[Plugins#Accept_payments|Accept payments]] plugin activated and event with specified id has
Returns true if [[Custom_Features#Accept_Payments|Accept Payments]] Custom Feature activated and event with specified id has
configured price. If no paramentes specified then method returns true if payments plugin activated and at least
configured price. If no parameters specified then method returns true if payments Custom Feature activated and at least
one event has configured price. Otherwise returns false.
one event has configured price. Otherwise returns false.
Returns Boolean.
Returns Boolean.
Return plugin status true if status active, else false. <var>$pluginName</var> parameter is a plugin identifier.See [[Plugins|plugins]] page for full plugins description. See [[#Plugin's identifiers|list of available plugin's names]].
Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[#Plugin's identifiers|list of available Custom Features' names]].
See [[Errors handling]] for details.
See [[Errors handling]] for details.
* -32001 Plugin is not activated
* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32010 Some required params are missed
* -32011 Params is not array
* -32011 Params is not array
* fixed_country_prefix
* fixed_country_prefix
* max_group_bookings
* max_group_bookings
*: [[Plugins#Group bookings|Group Booking plugin]] configuration. Integer.
*: [[Custom_Features#Group_Bookings|Group Bookings Custom Feature]] configuration. Integer.
* max_time_till_event
* max_time_till_event
* min_time_till_event
* min_time_till_event
*: Please note that <code>classic</code> timeline type is deprecated and not supported anymore.
*: Please note that <code>classic</code> timeline type is deprecated and not supported anymore.
=====Accept payments plugin params=====
=====Accept Payments Custom Feature params=====
Read more about [[Plugins#Accept payments|Accept payments plugin configuration]].
Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].
* allow_delay_payment
* allow_delay_payment
*: Sales tax option. Integer. You should divide by 100 to get percent value.
*: Sales tax option. Integer. You should divide by 100 to get percent value.
=====Cancellation Policy plugin params=====
=====Cancellation Policy Custom Feature params=====
Read more about [[Plugins#Cancellation Policy|Cancellation policy plugin configuration]].
Read more about [[Custom_Features#Cancellation_Policy|Cancellation Policy Custom Feature configuration]].
* cancelation_policy_text
* cancelation_policy_text
----
----
====Plugin's identifiers====
====Custom Features' identifiers====
Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.
* advanced_notification
* advanced_notification
*:Book Soon notification system plugin
*:Book Soon notification system
* any_unit
* any_unit
*:Any Employee selector plugin
*:Any Employee selector
* api
* api
*:API plugin
*:API
* approve_booking
* approve_booking
*:Approve booking plugin
*:Approve booking
* back_to_site
* back_to_site
*:Take me back home plugin
*:Take me back home
* contact_widget
* contact_widget
*:Contact widget plugin
*:Contact widget
* counter
* counter
*:Visitor Counter plugin
*:Visitor Counter
* custom_css
* custom_css
*:Custom CSS plugin
*:Custom CSS
* data_security
* data_security
*:Clean history plugin
*:Clean history
* description
* description
*:HTML description field for events
*:HTML description field for events
* event_category
* event_category
*:Service categories plugin
*:Service categories
* event_field
* event_field
*:Additional fields plugin
*:Additional fields
* facebookImage
* facebookImage
*:Facebook client info plugin
*:Facebook client info
* financial_dashboard
* financial_dashboard
*:Insights plugin
*:Insights
* google_analytics
* google_analytics
*:Google Adwords and analytics plugin
*:Google Adwords and analytics
* google_calendar_export
* google_calendar_export
*:Google calendar sync plugin
*:Google calendar sync
* group_booking
* group_booking
*:Group bookings plugin
*:Group bookings
* hipaa
* hipaa
*:HIPAA plugin
*:HIPAA
* limit_bookings
* limit_bookings
*:Limit bookings plugin
*:Limit bookings
* location
* location
*:Unit location plugin
*:Unit location
* mobile_app_backend
* mobile_app_backend
*:Mobile application plugin
*:Mobile application
* multiple_booking
* multiple_booking
*:Multiple bookings plugin
*:Multiple bookings
* news
* news
*:News plugin
*:News
* paid_events
* paid_events
*:Accept payments plugin
*:Accept payments
* promo
* promo
*:Simply Smart Promotions plugin
*:Simply Smart Promotions
* recap
* recap
*:Daily report plugin
*:Daily report
* secure
* secure
*:SSL plugin
*:SSL
* status
* status
*:Status plugin
*:Status
* unit_colors
* unit_colors
*:Providers color coding plugin
*:Providers color coding
* user_license
* user_license
*:Terms and conditions plugin
*:Terms and conditions
* cancelation_policy
* cancelation_policy
*:Cancellation Policy
*:Cancellation Policy
See [[Plugins]] page for description for each plugin.
See [[Custom_Features|Custom Features]] page for description for each .
----
----