FuzzyBot: Updating to match new version of source page

2026-02-05T15:59:31Z

Updating to match new version of source page

← Older revision		Revision as of 15:59, 5 February 2026
Line 2:		Line 2:
	{{#seo:		{{#seo:
	\|title=Catalogue - SimplyBook.me		\|title=Catalogue - SimplyBook.me
	\|description=Learn ~~about the SimplyBook~~.~~me API built on JSON-RPC protocol~~. ~~Access remote services via HTTPS with JSON-serialized requests!~~		\|description=Learn aPI methods for booking marketplace catalog. Search companies, services, promotions. Developer documentation for building booking directories and searc...
	\|titlemode=append		\|titlemode=append
	\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url		\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
	}}		}}


	==General Information==		==General Information==
Line 38:		Line 39:
	"1": {		"1": {
	"id": "1",		"id": "1",
	"name": "~~Часовая фотосесcия~~",		"name": "Hourly photoshoot",
	"duration": "60",		"duration": "60",
	"hide_duration": "0",		"hide_duration": "0",
	"description": "<p>~~Если Вы хотите попробовать себя в роли модели, но не определились с образом~~. <br /> 5-7 ~~отретушированных и готовых к печати фотографий~~ + ~~отснятый материал на диске~~</p>",		"description": "<p>If you want to try yourself as a model but haven't decided on an image. <br /> 5-7 retouched and print-ready photos + the raw footage on a disc </p>",
	"picture": "a200edab10b669225e22d2b3803a38b5.jpg",		"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
	"is_public": "1",		"is_public": "1",
Line 61:		Line 62:
	All calls of public service methods should have additional HTTP header:		All calls of public service methods should have additional HTTP header:

	* <code>X-Token</code> an authentication token. See [[#Authentication\|authentication]] section.		* <code>X-Token</code> an authentication token. See [[Catalogue#Authentication\|authentication]] section.

	===Endpoint===		===Endpoint===

	Use URL <code>https://user-api.simplybook.me/catalogue</code> for all service API calls listed in [[#Methods\|methods section]].		Use URL <code>https://user-api.simplybook.me/catalogue</code> for all service API calls listed in [[Catalogue#Methods\|methods section]].

	===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#getUserToken\|getUserToken]]</code> or <code>[[Authentication#getToken\|getToken]]</code> API methods 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'.		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#getUserToken\|getUserToken]]</code> or <code>[[Authentication#getToken\|getToken]]</code> API methods 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 ==

FuzzyBot: Updating to match new version of source page

2025-05-15T13:18:16Z

Updating to match new version of source page

New page

<languages/>
{{#seo:
|title=Catalogue - SimplyBook.me
|description=Learn about the SimplyBook.me API built on JSON-RPC protocol. Access remote services via HTTPS with JSON-serialized requests!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}

==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using JSON. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.

Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "<p>Если Вы хотите попробовать себя в роли модели, но не определились с образом. <br /> 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске</p>",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>

All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/catalogue</code> for all service API calls listed in [[#Methods|methods section]].

===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#getUserToken|getUserToken]]</code> or <code>[[Authentication#getToken|getToken]]</code> API methods 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 ==

=== getCategories ===

<code>getCategories()</code>

No arguments.
Returns Array.

Get lsit of ALL categories

----
=== getCities ===

<code>getCities($country)</code>

Parameters:

* '''$country''' String

Returns Array.

Returns city list as Array order by name

----
=== getCompanyCount ===

<code>getCompanyCount($filter)</code>

Parameters:

* '''$filter''' Object - filter object

Returns array.

Returns total companies count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

----
=== getCompanyInfo ===

<code>getCompanyInfo($login)</code>

Parameters:

* '''$login''' String

Returns Object.

Returns company information by company login

----
=== getCompanyList ===

<code>getCompanyList($filter, $from, $limit)</code>

Parameters:

* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit

Returns array.

Returns companies list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

----
=== getCompanyMarkers ===

<code>getCompanyMarkers($filter, $bounds, $zoom, $clustering)</code>

Parameters:

* '''$filter''' Object - filter object
* '''$bounds'''
* '''$zoom'''
* '''$clustering'''

Returns array.

Returns company markers$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

----
=== getCompanyReviews ===

<code>getCompanyReviews($login)</code>

Parameters:

* '''$login''' String

Returns Object.

Returns company reviews list

----

=== getCountries ===

<code>getCountries()</code>

No arguments.
Returns Array.

Returns country list as Array order by name

----

=== getFeedbackList ===

<code>getFeedbackList()</code>

No arguments.
Returns Array.

Get lsit of ALL simplybook feedbacks

----

=== getPromotionCount ===

<code>getPromotionCount($filter)</code>

Parameters:

* '''$filter''' Object - filter object

Returns array.

Returns total active promotions count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

----

=== getPromotionInfo ===

<code>getPromotionInfo($id, $feedbackFrom, $feedbackCount)</code>

Parameters:

* '''$id''' Integer
* '''$feedbackFrom''' Integer = 0
* '''$feedbackCount''' Integer = 100

Returns Object.

Returns promotion information by id

----

=== getPromotionList ===

<code>getPromotionList($filter, $from, $limit)</code>

Parameters:

* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit

Returns array.

Returns active promotion list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

----

=== getPromotionListByIds ===

<code>getPromotionListByIds($ids)</code>

Parameters:

* '''$ids'''

Returns array.

Returns active promotion list

----

=== getPromotionReviews ===

<code>getPromotionReviews($promotionId)</code>

Parameters:

* '''$promotionId''' Integer

Returns Object.

Returns promotion reviews list

----

=== getRecentCompanies ===

<code>getRecentCompanies($count)</code>

Parameters:

* '''$count''' Integer

Returns Array.

Returns list of companies ordered by date DESC

----

=== getRecentFeedbacks ===

<code>getRecentFeedbacks($count)</code>

Parameters:

* '''$count''' Integer

Returns Array.

Returns list of feedbacs ordered by date DESC

----

=== getRecentPromotions ===

<code>getRecentPromotions($count)</code>

Parameters:

* '''$count''' Integer

Returns Array.

Returns list of promotions ordered by date DESC

----

=== getRelatedPromotions ===

<code>getRelatedPromotions($id, $count)</code>

Parameters:

* '''$id''' Integer
* '''$count''' Integer = 10

Returns Array.

Returns related promotions by given promotion id

----

=== getTags ===

<code>getTags($filter)</code>

Parameters:

* '''$filter''' Object - filter object

Returns Array.

Returns tags list$filter filter params. Object that contains following params
<pre>
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String
</pre>
Use tag_ids OR tags

----

=== getTopCities ===

<code>getTopCities()</code>

No arguments.
Returns Array.

Returns city list as Array order by company count in city

----

=== getTopCountries ===

<code>getTopCountries()</code>

No arguments.
Returns Array.

Returns country list as Array order by company count in country

Catalogue/en - Revision history

FuzzyBot: Updating to match new version of source page

FuzzyBot: Updating to match new version of source page