With the Spiagge.it API, you can integrate your software with the Spiagge.it platform.
\nAll Spiagge.it products use this API set.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"40077604","collectionId":"77b1af86-9c48-4e54-afb1-b8ef414ce86d","publishedId":"2sAYBXBqaG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ffc100"},"publishDate":"2024-11-28T18:11:24.000Z"},"item":[{"name":"Authentication","item":[{"name":"oauth/access_token","event":[{"listen":"test","script":{"id":"cb918b1d-27e0-4b2f-8610-6026726146b9","exec":["var jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"access_token\", jsonData.access_token);"],"type":"text/javascript","packages":{}}}],"id":"07227b13-e169-4a2d-9e3c-456012b11c82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"client_id"},{"key":"password","value":"client_secret"}]},"isInherited":false},"method":"GET","header":[],"url":"https://legacy.spiagge.it/app/world/api/v1/oauth/access_token","description":"This endpoint generates a new access_token.
\n","urlObject":{"path":["access_token"],"host":["https://legacy.spiagge.it/app/world/api/v1/oauth"],"query":[],"variable":[]}},"response":[{"id":"d13fb9c1-294f-418f-a6e5-c5a79df6f29a","name":"oauth/access_token","originalRequest":{"method":"GET","header":[],"url":"https://legacy.spiagge.it/app/world/api/v1/oauth/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"access_token\": \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFG\",\r\n \"token_type\": \"bearer\",\r\n \"expire_in\": 300\r\n}"}],"_postman_id":"07227b13-e169-4a2d-9e3c-456012b11c82"}],"id":"78c039ed-7390-4bac-b34e-5279702e378d","description":"The authentication is required to use the Spiagge.it API.
\nBefore making a request, you have to generate an access_token. Include the access_token in the requests as an Authorization Bearer header.
\nTo request a pair of API key, send an e-mail to Spiagge.it support team support@spiagge.it.
\nIf you are a software house, and you embed the keys into an on-premise software, you have to require a different key for each of your customers.
\n","_postman_id":"78c039ed-7390-4bac-b34e-5279702e378d"},{"name":"Beaches","item":[{"name":"Licenses","item":[{"name":"beaches/","id":"4c63d902-4a2d-4eb2-931f-f65ee526ca40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"access_token"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"work\": \n\t\t{\n\t\t\t\"name\": \"Bagno Maria\",\n\t\t \"phone\":\n\t\t \t{\n\t\t \t\t\"areaCode\":\"+39\",\n\t\t \t\t\"number\": \"123456789\"\n\t\t \t},\n\t\t \"email\": \"esempio@esempio.it\",\n\t\t \"website\": \"https://www.google.com\",\n\t\t \"facebookId\": \"1234567890\",\n\t\t \"facebookUrl\": \"https://www.facebook.com/123456789/\",\n\t\t \"vatCode\": \"0123456789\",\n\t\t \"taxCode\": \"0123456789\"\n\t\t},\n\t\"places\": \n\t\t{\n\t\t\t\"name\": \"Bagno Maria\",\n\t\t\t\"street\": \"Via Roma\",\n\t\t\t\"city\": \"Rimini\",\n\t\t\t\"zip\": \"47900\",\n\t\t\t\"state\": \"RN\",\n\t\t\t\"country\": \"IT\"\n\t\t}\n}"},"url":"https://legacy.spiagge.it/app/world/api/v1/beaches/","urlObject":{"path":[""],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c63d902-4a2d-4eb2-931f-f65ee526ca40"},{"name":"beaches/To obtain the list of license reservations, you must perform a GET request on the \"registrations\" resource family.
\nThe API system doesn't allow the response time to exceed 60 seconds. For this reason, you cannot get all license reservations in just one request. When you use this endpoint, apply one or more filters to limit the size of the result.
\nNB. All GET parameters are optional.
\n","urlObject":{"path":["demo2","registrations",""],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[{"description":{"content":"Search only for active reservations starting from the indicated date(identified such as midnight in UTC time zone).
\n","type":"text/plain"},"key":"from","value":"1683590400"},{"description":{"content":"Search only for active reservations up to the indicated date (identified such as midnight in UTC time zone).\nIf the filter from and the filter to coincide, the active reservations on that particular day are shown.
\n","type":"text/plain"},"key":"to","value":"1683590400"},{"disabled":true,"description":{"content":"Search by booking status. The accepted values are: 1:temporary, 2:confirmed, 3:seasonal.
\n","type":"text/plain"},"key":"status","value":"2"},{"disabled":true,"description":{"content":"Search by umbrella or gazebo name to which the reservations are associated.
\n","type":"text/plain"},"key":"umb","value":"10A"},{"disabled":true,"description":{"content":"Search by sector to which the reservations are associated.
\n","type":"text/plain"},"key":"sector","value":"1"},{"disabled":true,"description":{"content":"Search by name of special spot (cabin, car park, loose bed, etc.) to which the reservations are associated.
\n","type":"text/plain"},"key":"place","value":"3B"}],"variable":[]}},"response":[],"_postman_id":"44a1fc56-9dca-4b90-95bd-9aabfc764b8d"},{"name":"beaches/To add a new reservation, you need to perform a POST request on the \"registrations\" resource.
\n","urlObject":{"path":[":beach","registrations",""],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[{"type":"any","value":"demo2","key":"beach"}]}},"response":[{"id":"cc8e5ad1-c7f3-4f92-8d83-2191a7fef4fe","name":"beaches/Retrieve the reservation data with this endpoint.
\n","urlObject":{"path":[":beach","registrations",":registration"],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[{"type":"any","value":"demo2","key":"beach"},{"description":{"content":"Reservation ID
\n","type":"text/plain"},"type":"any","value":"27356","key":"registration"}]}},"response":[{"id":"48054d65-f92d-4446-b403-593488d82bae","name":"beaches/You can update a reservation with a PUT request to the registrations/reg> endpoint.
\nInside the payload you can insert only the properties that you want to update.
\n","urlObject":{"path":[":beach","registrations",":registration"],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[{"type":"any","value":"demo2","key":"beach"},{"type":"any","value":"27356","key":"registration"}]}},"response":[{"id":"cddc61a7-8207-440b-8dbe-d265f7cf5f4e","name":"beaches/Endpoint cancellazione prenotazione.
\nLe prenotazioni cancellate tramite API vengono inserite nel cestino della licenza.
\n","urlObject":{"path":[":beach","registrations",":registration"],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[{"type":"any","value":"demo2","key":"beach"},{"type":"any","value":"1170","key":"registration"}]}},"response":[],"_postman_id":"9855795a-76d4-4be3-8bb2-f95d61b95d13"},{"name":"beaches/You could add an expense from a third-party application to a Spiagge.it reservation. This is the most important endpoint for the restaurant integration flow.
\nExpense object
\nData property object
\nProduct object
\n","urlObject":{"path":[":beach","registrations",":registration","expenses",""],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[{"type":"any","value":"demo2","key":"beach"},{"type":"any","value":"29476","key":"registration"}]}},"response":[],"_postman_id":"4d85c8d6-d59e-49fd-904d-1c8f562e159e"},{"name":"beaches/Questa rotta permette alle applicazioni di terzi di aggiungere nuove spese.
\n","urlObject":{"path":[":beach","registrations",":registration","expenses",""],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[{"disabled":true,"key":"access_token","value":"access_token"}],"variable":[{"type":"any","value":"demo2","key":"beach"},{"type":"any","value":"29476","key":"registration"}]}},"response":[],"_postman_id":"3e5fd3bb-56f9-428c-8cd8-316e01f104ad"},{"name":"beaches/The reservation object is the most important resource of the Spiagge.it PRO platform.
\nRegistration object
\nThe object properties are:
\nReservation customer object
\nInside the registration object there is a secondary object for the customer data. The properties of this object are:
\nReservation beach service object
\nThe details of the beach services added to the reservation:
\n","_postman_id":"7a2bae9e-2dbb-45ff-89f3-45d7a6a72134"},{"name":"Cashflows","item":[{"name":"beaches/From filter in UNIX timestamp. [optional]
\n","type":"text/plain"},"key":"from","value":"1683590400"},{"description":{"content":"To filter in UNIX timestamp. [optional]
\n","type":"text/plain"},"key":"to","value":"1683590400"}],"variable":[]}},"response":[{"id":"0787c226-15d3-4edc-803e-9ca6dc7a0683","name":"beaches/Cash flow ID
\n","type":"text/plain"},"type":"any","value":"12263504","key":"cashflow"}]}},"response":[{"id":"419007fa-470a-4808-ada1-da7128e62b40","name":"beaches/The cash flow is the object used to describe an economic movement.
\nCashflow object
\n","_postman_id":"6b8bbfba-b025-4465-a170-1d6519a4d64c"},{"name":"Map","item":[{"name":"beaches/The spot object is a map element.
\nSpot object
\nThe object properties are:
\n","_postman_id":"938c4bb6-fae6-4407-a04d-fe87ad1e5aec"},{"name":"Search","item":[{"name":"beaches/search/","id":"8829625f-9fc8-4e28-899b-ffeeb7bf7438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"access_token"}]},"isInherited":false},"method":"GET","header":[],"url":"https://legacy.spiagge.it/app/world/api/v1/beaches/search/?city=Stintino&country=it","urlObject":{"path":["search",""],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[{"disabled":true,"key":"lat","value":"44.077157"},{"disabled":true,"key":"long","value":"12.574487"},{"key":"city","value":"Stintino"},{"disabled":true,"key":"state","value":"rn"},{"key":"country","value":"it"}],"variable":[]}},"response":[],"_postman_id":"8829625f-9fc8-4e28-899b-ffeeb7bf7438"}],"id":"96626213-90a4-4eac-889a-e2d7cdd499b9","_postman_id":"96626213-90a4-4eac-889a-e2d7cdd499b9","description":""},{"name":"Statistics","item":[{"name":"beaches/The cash flow report is essential for viewing the day's cash movements, taxation, and division by payment method.
\nThe POST request includes a payload with several applicable filters. The list of applicable filters is as follows.
\nNB. To get the daily report, startDate and endDate must be equal.
\nThe report response provides the following graphs:
\nDivision by payment method
\nStatistics divided by payment method in turn broken down by taxation method.
\nDivision by type of booking duration
\nDivision of receipts by type of booking duration. Daily, 2 days, weekly, etc…
\nList of individual movements
\nList of cash movements.
\n","urlObject":{"path":[":beach","statistics","cash-flows"],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[{"type":"any","value":"demo2","key":"beach"}]}},"response":[{"id":"e0935aa7-153a-4fb3-8625-644fd3438f29","name":"beaches/Comparison mode to detect duplicates - ''/ 'check' / 'merge'
\n","type":"text/plain"},"key":"mode","value":"check"}],"variable":[]}},"response":[],"_postman_id":"542dd413-7079-497e-b743-07c61115fdd8"},{"name":"beaches/You can integrate the Spiagge.it platform to an access control system.
\nThe ticket object represents the code that the gate reader can scan. One ticket can allow only one entrance or multiple entrances.
\nThere are multiple types of tickets: people entrance, cabin access, vehicles, etc.
\n","_postman_id":"04d9e1f3-23be-4d26-addd-2146eaf18046"},{"name":"Gates","item":[{"name":"beaches/This is the structure of the notification request from Spiagge.it to the third-party server.
\nThe third-party server has to response with HTTP status code 200 to confirm.
\n","urlObject":{"host":["{{third_party_webhook_endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"85a3f53e-83dc-487b-989a-5352d6f1e259","name":"Webhook request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"license\": \"demo2\" ,\r\n \"resource\": \"reservation\",\r\n \"action\": \"create\",\r\n \"resourceId\": 1234\r\n}","options":{"raw":{"language":"json"}}},"url":"https://third_party_webhook_endpoint.example.com/webhook"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8f6ab926-8b91-4620-a24a-715b79048e10"},{"name":"beaches/webhook-emulator","id":"ac197cae-206e-494d-b774-fc04de33fb5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"access_token"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://third-party-webhook-url\",\n \"license\": \"demo2\",\n \"resource\": \"reservation\",\n \"action\": \"create\",\n \"resourceId\": 14525895\n}"},"url":"https://legacy.spiagge.it/app/world/api/v1/beaches/webhook-emulator","description":"This endpoint allows to generate a fake webhook request to test and develop the third-party endpoint.
\n","urlObject":{"path":["webhook-emulator"],"host":["https://legacy.spiagge.it/app/world/api/v1/beaches"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac197cae-206e-494d-b774-fc04de33fb5f"}],"id":"88843aa4-3998-47a7-a407-80fa3fd34b63","description":"The polling mechanism with Spiagge.it API is deny. For this reason is available a webhook to receive the notifications when someone updates an object in Spiagge.it platform.
\nThe beach resource represents a license of Spiagge.it PRO.
\nAll license data are inside the beach path. We use this architecture to segregate the data of each license.
\n","_postman_id":"0151f641-32d3-435e-a3e3-4552c898d459"}],"event":[{"listen":"prerequest","script":{"id":"7018c512-62ae-4d7c-bb95-8fb97db015d2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8953e1ef-24e2-4289-a88e-13b60e35b159","type":"text/javascript","exec":[""]}}],"variable":[{"key":"world_api_host","value":"https://legacy.spiagge.it/app/world/api/v1/","type":"string"},{"key":"beach","value":"demo2","type":"string"},{"key":"access_token","value":"access_token","type":"string"},{"key":"client_id","value":"client_id","type":"string"},{"key":"client_secret","value":"client_secret","type":"string"}]}