This documentation regards PopGuide Partners API, available in two versions: v2 and v3.\nIf this is the first time that you are interfacing Partners API, please use the last version
\nIn order to use our API you need to have an active account on PopGuide platform and have received api key and secret to be able to connect; if you didn't receive them, just ask our \"Vox Account Department\".
\nBefore starting to consume Partners API you need a token, obtainable with a New session request, and adding it in the header of every api request:
Authorization: Bearer xxxxxxxxxTOKENxxxxxxxxx\nHere all available params to create an Account on PopGUIDE
\ncredential in order to have custom credential you need to be allow by Vox Account Department and after that these possibility works only when an account is created with shared_creds:true; here parameters:
accesses is an array of hashes and each hash can have three parameters and cannot be used together with package_id
{\n \"success\": true,\n \"group\": {\n \"id\": 720301,\n \"name\": \"Account Test for API V3\",\n \"qty\": 3,\n \"share_creds\": true,\n \"payment_method\": \"prepaid\",\n \"activated\": false,\n \"termination_date\": \"2020-10-01\",\n \"pdf_custom_text\": \"Just scan the QR code\",\n \"created_at\": \"2021-06-17T10:28:36.816Z\",\n \"qr_code\": \"IyMjTUlTQy0wMDA2MzkjIyM0Mjg0OSMjIw==\",\n \"credentials\": [\n {\n \"username\": \"XXXXXXX\",\n \"password\": \"XXXXXX\",\n \"qr_code\": \"hiu3gh43g4h32g4jh32\",\n \"dynamic_link\": \"https://unlockmy.guide/AZAZAZ\"\n }\n ],\n \"pop_maps\": [\n {\n \"pop_map\": {\n \"id\": 579,\n \"name\": \"ROME - 1 speaker - Vox audio - VOX CITY GUIDE\"\n },\n \"home_location\": null,\n \"tour_documents\": null\n }\n ],\n \"branding\": null\n }\n}\n\nIf you need to add another PopMap to an existing account you have to create a POST request indicating the account id in the url and use these parameters:
\n","urlObject":{"path":["partners_api/v3","accounts","{{account_id}}","pop_map"],"host":["https://popguide-staging.herokuapp.com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"57b8bf7b-2b18-4c59-ac01-b49473df66f0"},{"name":"Update Account","id":"23833545-ae6d-445a-aa72-a0a9ac005d8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"termination_date\": \"2020-01-01\",\n\t\"name\": \"Changed name for group account\"\n}"},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/accounts/154134","description":"Parameters that can be changed:
\n","urlObject":{"path":["partners_api/v3","accounts","154134"],"host":["https://popguide-staging.herokuapp.com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"23833545-ae6d-445a-aa72-a0a9ac005d8f"},{"name":"Accounts List","id":"5945a268-ebc8-461c-b13b-5d3283e78c0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/accounts","urlObject":{"path":["partners_api/v3","accounts"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5945a268-ebc8-461c-b13b-5d3283e78c0c"},{"name":"Account Detail","id":"6903d581-103a-4564-b0d6-48d69dd5d831","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/accounts/567633","urlObject":{"path":["partners_api/v3","accounts","567633"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6903d581-103a-4564-b0d6-48d69dd5d831"},{"name":"Delete Account","id":"6a713d53-b122-41f0-8a2d-5d4b619cebfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/accounts/567633/delete","description":"In order to delete an account, the following conditions MUST be met:
\nThe account must be creatd less than 120 days ago.
\nThe account must not have logged in, not even once.
\nIf the account has not been invoiced, and the previous 2 conditions are satisfied, then in can be deleted. On the other hand, if the account has already been invoiced, the operator must be enabled manually to delete already invoiced accounts, or he won't be able to deleted them.
\nFor more informations, or if you have any doubts, please contact us.
\n","urlObject":{"path":["partners_api/v3","accounts","567633","delete"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a713d53-b122-41f0-8a2d-5d4b619cebfe"}],"id":"6da6dab5-a0a4-45f2-be15-c8a677ed6d13","event":[{"listen":"prerequest","script":{"id":"fe4c7580-d2f1-40db-b74e-ae63f2e52403","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dd5810d7-4c93-40f2-bd34-628d6f0fd95b","type":"text/javascript","exec":[""]}}],"_postman_id":"6da6dab5-a0a4-45f2-be15-c8a677ed6d13","description":""},{"name":"Star Points","item":[{"name":"All Star Points","id":"f20e1e3f-1217-45a8-946c-cbdbdabba56f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/star_points","urlObject":{"path":["partners_api/v3","star_points"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f20e1e3f-1217-45a8-946c-cbdbdabba56f"},{"name":"StarPoint Groups","id":"4d102f6a-0bae-4197-ba51-65fe64cf7cde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/star_points/groups","urlObject":{"path":["partners_api/v3","star_points","groups"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d102f6a-0bae-4197-ba51-65fe64cf7cde"},{"name":"Create Star Point","event":[{"listen":"test","script":{"id":"a4c5a13a-c369-427c-89d7-86072d38c593","exec":["pm.globals.set('star_point_id', pm.response.json()['star_point']['id'])"],"type":"text/javascript"}}],"id":"5806c128-8dd1-419b-bf95-b251291890fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/star_points?star_point_category_id=1&name=Hotel Ritz&location_id=355&lat=51.5069&lng=-0.14157&description=Famous hotel&image=http://www.ritzparis.com/sites/default/files/styles/1440x748/public/images/card_page/slideshow/ritz-paris-hotel-suite-imperiale-chambre1.jpg?itok=DMjgP7VM&translations[][language_id]=1&translations[][name]=Albergo Ritz&translations[][description]=Alberto Famoso&web=https://www.google.com&phone=+39 06 606060&email=temp@temp.org","urlObject":{"path":["partners_api/v3","star_points"],"host":["https://popguide-staging.herokuapp.com"],"query":[{"description":{"content":"To get all StarPoints categories you can use \"Star Point Categories\" request
\n","type":"text/plain"},"key":"star_point_category_id","value":"1"},{"key":"name","value":"Hotel Ritz"},{"key":"location_id","value":"355"},{"key":"lat","value":"51.5069"},{"key":"lng","value":"-0.14157"},{"key":"description","value":"Famous hotel"},{"description":{"content":"It could be image file Base64 encoded or an external URI
\n","type":"text/plain"},"key":"image","value":"http://www.ritzparis.com/sites/default/files/styles/1440x748/public/images/card_page/slideshow/ritz-paris-hotel-suite-imperiale-chambre1.jpg?itok=DMjgP7VM"},{"key":"translations[][language_id]","value":"1"},{"key":"translations[][name]","value":"Albergo Ritz"},{"key":"translations[][description]","value":"Alberto Famoso"},{"key":"web","value":"https://www.google.com"},{"key":"phone","value":"+39 06 606060"},{"key":"email","value":"temp@temp.org"}],"variable":[]}},"response":[],"_postman_id":"5806c128-8dd1-419b-bf95-b251291890fd"},{"name":"Single Star Point","id":"d5bb4777-4916-4062-bda2-9bfaaad68ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/star_points/1","urlObject":{"path":["partners_api/v3","star_points","1"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5bb4777-4916-4062-bda2-9bfaaad68ad9"},{"name":"Delete Star Point","id":"786d8147-ae95-4acd-ac21-87e2b19c28fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/star_points/{{star_point_id}}/delete","description":"Before to run a delete you should do a 'Create Star Point'
\n","urlObject":{"path":["partners_api/v3","star_points","{{star_point_id}}","delete"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"786d8147-ae95-4acd-ac21-87e2b19c28fc"}],"id":"9f7f56ba-67f6-4c31-9b3a-9a2bd088d4a0","_postman_id":"9f7f56ba-67f6-4c31-9b3a-9a2bd088d4a0","description":""},{"name":"Home Locations","item":[{"name":"All home locations","id":"20c21da5-03f3-4689-9770-4d0198441cc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/home_locations","urlObject":{"path":["partners_api/v3","home_locations"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"20c21da5-03f3-4689-9770-4d0198441cc9"}],"id":"36f0587e-710b-4380-9d02-349d46178281","_postman_id":"36f0587e-710b-4380-9d02-349d46178281","description":""},{"name":"Branding","item":[{"name":"All brandings","id":"818ef823-32b4-4650-8b02-3eb61eaa5889","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/brandings","urlObject":{"path":["partners_api/v3","brandings"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"818ef823-32b4-4650-8b02-3eb61eaa5889"}],"id":"826457e4-217e-4bb9-a9c5-5895e6f3672d","_postman_id":"826457e4-217e-4bb9-a9c5-5895e6f3672d","description":""},{"name":"Tour Documents","item":[{"name":"Translations","item":[{"name":"Lista traduzioni","id":"9cbcad55-e3f0-450a-b9b6-a172b90cee0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_doc_translations","urlObject":{"path":["partners_api/v3","tour_doc_translations"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cbcad55-e3f0-450a-b9b6-a172b90cee0a"},{"name":"Tour Doc Translation Add with PDF file","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":["pm.globals.set('last_tour_doc_translation_id', pm.response.json()['tour_doc_translation']['id'])"],"type":"text/javascript"}}],"id":"600e6d16-fcf6-44d2-ac85-924e91a97088","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"tour_doc_translation[name]","value":"Translate Tour doc version","type":"text"},{"key":"tour_doc_translation[pdf]","type":"file","src":"/Users/claudio/Downloads/Single-Page-6pp-Italian-Group-Leaflet.pdf"},{"key":"tour_doc_translation[language_id]","value":"4","type":"text","description":"To get id of language user Languages request
\n"},{"key":"tour_doc_translation[tour_document_id]","value":"{{last_tour_document_id}}","type":"text"},{"key":"tour_document_id","value":"{{last_tour_document_id}}","type":"text"}]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_doc_translations","urlObject":{"path":["partners_api/v3","tour_doc_translations"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"600e6d16-fcf6-44d2-ac85-924e91a97088"},{"name":"Tour Doc Translation Add with external URL","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":["pm.globals.set('last_tour_doc_translation_id', pm.response.json()['tour_doc_translation']['id'])"],"type":"text/javascript"}}],"id":"46e6397a-0c00-400c-9378-f6d94db142b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"tour_doc_translation[name]","value":"Translate Tour doc version","type":"text"},{"key":"tour_doc_translation[language_id]","value":"4","type":"text","description":"To get id of language user Languages request
\n"},{"key":"tour_doc_translation[tour_document_id]","value":"{{last_tour_document_id}}","type":"text"},{"key":"tour_document_id","value":"{{last_tour_document_id}}","type":"text"},{"key":"tour_doc_translation[out_url]","value":"https://www.voxtours.com","type":"text"}]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_doc_translations","urlObject":{"path":["partners_api/v3","tour_doc_translations"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"46e6397a-0c00-400c-9378-f6d94db142b6"},{"name":"Tour Doc Translation Delete","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":[""],"type":"text/javascript"}}],"id":"a877d167-ce6e-4e83-9dbf-6b4da1606d3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_doc_translations/{{last_tour_doc_translation_id}}","urlObject":{"path":["partners_api/v3","tour_doc_translations","{{last_tour_doc_translation_id}}"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a877d167-ce6e-4e83-9dbf-6b4da1606d3e"}],"id":"29cbad1d-4019-45c8-b54d-d72c161a7c90","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"_postman_id":"29cbad1d-4019-45c8-b54d-d72c161a7c90","description":""},{"name":"Tour Documents List","id":"194ca4af-b799-4da5-918b-373f19fe8ccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_documents","urlObject":{"path":["partners_api/v3","tour_documents"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"194ca4af-b799-4da5-918b-373f19fe8ccf"},{"name":"Tour Document Add with PDF file","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":["pm.globals.set('last_tour_document_id', pm.response.json()['tour_document']['id'])"],"type":"text/javascript"}}],"id":"47c07b1b-89e9-45d6-af69-6010e5bde608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tour_document[name]","value":"Tour docs","type":"text"},{"key":"tour_document[pdf]","type":"file","src":"/Users/claudio/Downloads/Single-Page-6pp-Italian-Group-Leaflet.pdf"}]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_documents","urlObject":{"path":["partners_api/v3","tour_documents"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"47c07b1b-89e9-45d6-af69-6010e5bde608"},{"name":"Tour Document Add with external URL","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":["pm.globals.set('last_tour_document_id', pm.response.json()['tour_document']['id'])"],"type":"text/javascript"}}],"id":"88d14317-6771-433d-a7c8-c6dc949dfd4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tour_document[name]","value":"Tour docs","type":"text"},{"key":"tour_document[out_url]","value":"https://www.voxtours.com","type":"text"}]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_documents","urlObject":{"path":["partners_api/v3","tour_documents"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"88d14317-6771-433d-a7c8-c6dc949dfd4f"},{"name":"Tour Document Update","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":[""],"type":"text/javascript"}}],"id":"011dfa19-8a6b-46f3-b0c9-3df99be1195b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"tour_document[name]","value":"Update Tour doc","type":"text"},{"key":"tour_document[pdf]","type":"file","src":"/Users/claudio/Downloads/Single-Page-6pp-Italian-Group-Leaflet.pdf"},{"key":"tour_document[out_url]","value":"https://www.voxtours.com","type":"text"}]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_documents/{{last_tour_document_id}}","description":"In this example update we are passing both pdf and out_url but just one of these must be passed
\n","urlObject":{"path":["partners_api/v3","tour_documents","{{last_tour_document_id}}"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"011dfa19-8a6b-46f3-b0c9-3df99be1195b"},{"name":"Tour Document Delete","event":[{"listen":"test","script":{"id":"e2a5ea0e-fa79-44db-bc90-1ef280934248","exec":[""],"type":"text/javascript"}}],"id":"f060c38c-eb53-492f-b643-78ceebb76579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/tour_documents/{{last_tour_document_id}}","urlObject":{"path":["partners_api/v3","tour_documents","{{last_tour_document_id}}"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f060c38c-eb53-492f-b643-78ceebb76579"}],"id":"16eebf42-ecba-4419-94d4-025c552d85b2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"_postman_id":"16eebf42-ecba-4419-94d4-025c552d85b2","description":""},{"name":"WebApp","item":[{"name":"Get all links","id":"14f5766a-7bba-47a6-8989-7e8ed1fa9e2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/web_apps","urlObject":{"path":["partners_api/v3","web_apps"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"14f5766a-7bba-47a6-8989-7e8ed1fa9e2d"},{"name":"Generate new link","id":"5197702d-9225-486d-ab04-8c32a6f28718","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"","type":"text"},{"key":"pop_map_id","value":"","type":"text"},{"key":"expiration_date","value":"","description":"Format 'YYYY-MM-DD'
\n","type":"text"}]},"url":"https://popguide-staging.herokuapp.com/partners_api/v3/web_apps","urlObject":{"path":["partners_api/v3","web_apps"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5197702d-9225-486d-ab04-8c32a6f28718"},{"name":"Change name or expiration_date","id":"0ab58702-609d-4009-bea1-62d925d82363","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"PUT","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/web_apps/ID?name=&expiration_date","description":"Only name and expiration_date are available to be changed.\nSetting expiration_date in the past will disable the link in real time
In order to use WebApp endpoints you need to be enabled from your Vox Account
\n","event":[{"listen":"prerequest","script":{"id":"8da8d2bb-0743-485c-8a38-9fc5d928b7a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a1eb6b24-0f66-464e-8cdf-f8f86ec91416","type":"text/javascript","exec":[""]}}],"_postman_id":"d745bd6a-017f-49e3-8f8d-ed212ae61596"},{"name":"New sessions","event":[{"listen":"prerequest","script":{"id":"3cfa6ca9-9806-4810-ada5-4f4a4bd8dd67","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"38a00d4a-cb21-4695-ac7a-026d49af6553","exec":["pm.globals.set('api_token', pm.response.json()['token'])"],"type":"text/javascript"}}],"id":"e1084bb7-2c12-4937-8b99-4d572c355e23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/sessions?k=api_key&s=api_secret","description":"In order to use the API, you need API_KEY and API_SECRET, provided by Popguide.
\nWhen you set up key and secret and do first session request, token will be\nshared with all other api calls
\n","urlObject":{"path":["partners_api/v3","sessions"],"host":["https://popguide-staging.herokuapp.com"],"query":[{"description":{"content":"API_KEY
\n","type":"text/plain"},"key":"k","value":"api_key"},{"description":{"content":"API_SECRET
\n","type":"text/plain"},"key":"s","value":"api_secret"}],"variable":[]}},"response":[],"_postman_id":"e1084bb7-2c12-4937-8b99-4d572c355e23"},{"name":"Countries","id":"32b4911a-1e35-48a3-9087-978c489d0a6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/countries","urlObject":{"path":["partners_api/v3","countries"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"32b4911a-1e35-48a3-9087-978c489d0a6f"},{"name":"Languages","id":"56963a94-18d7-49a2-a805-3570b0a62573","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/languages","urlObject":{"path":["partners_api/v3","languages"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56963a94-18d7-49a2-a805-3570b0a62573"},{"name":"Locations","id":"75363b98-4469-4ee1-b67f-bca438bfc691","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/locations","urlObject":{"path":["partners_api/v3","locations"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75363b98-4469-4ee1-b67f-bca438bfc691"},{"name":"Star Point Categories","event":[{"listen":"prerequest","script":{"id":"06a19b25-a8e4-4eae-b85d-d26e3fe68bfa","exec":[""],"type":"text/javascript"}}],"id":"15e81b1c-334a-40b9-815b-d40f6325e342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/star_point_categories","urlObject":{"path":["partners_api/v3","star_point_categories"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"15e81b1c-334a-40b9-815b-d40f6325e342"},{"name":"PopMaps List","id":"094377ad-a666-4096-89fd-d585f9618764","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/pop_maps","description":"To search inside availables PopMaps there are 2 parameters that can be added in the query string:
\nExample:
\nhttps://popguide-staging.herokuapp.com/partners_api/v3/pop_maps?country=Italy&name=alberobello
\n","urlObject":{"path":["partners_api/v3","pop_maps"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"094377ad-a666-4096-89fd-d585f9618764"},{"name":"PopMap Detail","id":"9be8fe25-2df0-4fb7-a791-42050acd53ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/pop_maps/1","description":"Returns all the levels and POIs associated for each level.
\n","urlObject":{"path":["partners_api/v3","pop_maps","1"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9be8fe25-2df0-4fb7-a791-42050acd53ee"},{"name":"Packages list","id":"c9fb2c68-2148-44d1-ae2b-5f6a67ad01f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://popguide-staging.herokuapp.com/partners_api/v3/packages","description":"Returns a list of all available packages, is a readonly endpoint
\n","urlObject":{"path":["partners_api/v3","packages"],"host":["https://popguide-staging.herokuapp.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9fb2c68-2148-44d1-ae2b-5f6a67ad01f7"}],"id":"cd04f60f-7a22-4083-8322-f9de99ca9f8b","_postman_id":"cd04f60f-7a22-4083-8322-f9de99ca9f8b","description":""}],"event":[{"listen":"prerequest","script":{"id":"981ded2e-3262-439b-8ae8-f5ae09995b54","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"525b3060-da79-4730-98ac-3210652d0afd","type":"text/javascript","exec":[""]}}],"variable":[{"key":"mainhost","value":"https://popguide-staging.herokuapp.com"},{"key":"partner_api_path","value":"partners_api/v2"},{"key":"partner_api_v2_path","value":"partners_api/v2"},{"key":"partner_api_v3_path","value":"partners_api/v3"}]}