{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost:8002" } ], "info": { "name": "Simetric Club API Documentation", "_postman_id": "128b16f9-39a7-42f8-b833-452f3cea1353", "description": "API reference for the Simetric Club platform.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Events", "description": "", "item": [ { "name": "Get an event by its slug.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:post_slug", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:post_slug", "variable": [ { "id": "post_slug", "key": "post_slug", "value": "summer-festival", "description": "The event slug." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"title\": \"Summer Festival\",\n \"slug\": \"summer-festival\",\n \"content\": \"

Event description<\/p>\",\n \"category\": {},\n \"image\": \"https:\/\/example.com\/storage\/events\/summer-festival.jpg\",\n \"image_2\": null,\n \"description\": \"An outdoor music festival.\",\n \"ticket_form_color\": \"#000000\",\n \"timezone\": \"America\/Bogota\",\n \"currency\": \"USD\",\n \"votes\": {\"user_vote_type\": null, \"likes\": 0, \"dislikes\": 0},\n \"tags\": [],\n \"seat_map_config\": null,\n \"occupied_seats\": [],\n \"assistant_fields\": {},\n \"questions\": []\n },\n \"message\": \"Success\",\n \"code\": 200\n}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [App\\\\Post].\"}", "name": "" } ] }, { "name": "List the questions configured for an event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:post_slug\/questions", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:post_slug\/questions", "variable": [ { "id": "post_slug", "key": "post_slug", "value": "summer-festival", "description": "The event slug." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"statement\": \"What is your preferred meal?\",\n \"description\": \"Choose one option.\",\n \"require_confirmation\": false,\n \"required\": true,\n \"only_main_assistant\": true,\n \"type\": \"radio\",\n \"options\": [\"Vegetarian\", \"Regular\"]\n }\n ]\n}", "name": "" } ] }, { "name": "List the bank accounts configured for an event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:post_slug\/bank-accounts", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:post_slug\/bank-accounts", "variable": [ { "id": "post_slug", "key": "post_slug", "value": "summer-festival", "description": "The event slug." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"bank_account\",\n \"identification_number\": \"900123456\",\n \"name\": \"Simetric Club\",\n \"bank\": \"Example Bank\",\n \"account_number\": \"000123456789\",\n \"account_type\": \"savings\",\n \"email\": \"payments@example.com\",\n \"image\": null\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Ticket Types", "description": "", "item": [ { "name": "List the ticket types available for an event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:post_slug\/ticket-types", "query": [ { "key": "display_disabled", "value": "", "description": "Include disabled ticket types. Defaults to false.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/posts\/:post_slug\/ticket-types?display_disabled=", "variable": [ { "id": "post_slug", "key": "post_slug", "value": "summer-festival", "description": "The event slug." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The endpoint is available both as an event-scoped resource and as the\nglobal `\/api\/ticket-types` route." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"General Admission\",\n \"is_courtesy\": false,\n \"is_tax_included\": true,\n \"payment_methods\": {},\n \"payment_method_commissions\": {},\n \"max_availability_date\": null,\n \"no_require_confirmation\": true,\n \"min_by_sell\": 1,\n \"max_by_sell\": 10,\n \"per_unit\": false,\n \"description\": \"Standard entry ticket.\",\n \"tax_rate\": 15,\n \"configured_amount\": \"100.00\",\n \"amount_base\": \"100.00\",\n \"amount_service\": \"0.00\",\n \"amount_with_service\": \"100.00\",\n \"amount_tax\": \"15.00\",\n \"amount_with_tax\": \"115.00\",\n \"amount_total\": \"115.00\",\n \"amounts_by_payment_method\": {},\n \"quantity\": 100,\n \"tickets_count\": 0,\n \"is_out_stock\": false,\n \"request_assistant_information\": false,\n \"all_assistants_same_price\": false,\n \"assistant_fields\": {},\n \"questions\": [],\n \"has_discounts\": false,\n \"addons\": []\n }\n ]\n}", "name": "" } ] }, { "name": "Apply a discount code to a ticket type and return its calculated price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ticket-types\/discount", "query": [], "raw": "{{baseUrl}}\/api\/ticket-types\/discount" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ticket_type_id\":1,\"discount_code\":\"EARLYBIRD\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"General Admission\",\n \"configured_amount\": \"100.00\",\n \"amount_total\": \"90.00\",\n \"has_discounts\": true\n },\n \"applied_discount\": {\n \"code\": \"EARLYBIRD\",\n \"discount\": 10,\n \"discount_unit\": \"percentage\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The selected ticket_type_id is invalid.\"}", "name": "" } ] }, { "name": "Generate a JPEG preview image of a ticket configuration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ticket-types\/preview", "query": [], "raw": "{{baseUrl}}\/api\/ticket-types\/preview" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "post_id", "value": "1", "type": "text", "description": "The existing post ID used as the preview base." }, { "key": "ticket_type_id", "value": "1", "type": "text", "description": "The existing ticket type ID used as the preview base." }, { "key": "invitation_template_active", "value": "", "type": "text", "description": "Enable the invitation template. Defaults to true." }, { "key": "invitation_template_qr_inactive", "value": "1", "type": "text", "description": "Hide the QR code. Defaults to false." }, { "key": "invitation_template_url", "value": "http:\/\/www.buckridge.biz\/tempora-culpa-voluptatem-magnam-et-eum", "type": "text", "description": "The invitation template URL." }, { "key": "margin_top", "value": "17139805.328689", "type": "text", "description": "The top margin." }, { "key": "margin_bottom", "value": "507.68133", "type": "text", "description": "The bottom margin." }, { "key": "font_size", "value": "66919839.9568", "type": "text", "description": "The invitation font size." }, { "key": "title_offset", "value": "105", "type": "text", "description": "The title vertical offset." }, { "key": "font_color", "value": "#000000", "type": "text", "description": "The invitation font color." }, { "key": "invitation_template_image", "src": [], "type": "file" }, { "key": "invitation_font_file", "src": [], "type": "file" } ] }, "description": "Configuration values are applied to temporary models and are not saved.\nThe response body is a binary image with `Content-Type: image\/jpeg`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"content_type\":\"image\/jpeg\"}", "name": "" } ] }, { "name": "List the ticket types available for an event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ticket-types", "query": [ { "key": "display_disabled", "value": "", "description": "Include disabled ticket types. Defaults to false.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/ticket-types?display_disabled=" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The endpoint is available both as an event-scoped resource and as the\nglobal `\/api\/ticket-types` route.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"General Admission\",\n \"is_courtesy\": false,\n \"is_tax_included\": true,\n \"payment_methods\": {},\n \"payment_method_commissions\": {},\n \"max_availability_date\": null,\n \"no_require_confirmation\": true,\n \"min_by_sell\": 1,\n \"max_by_sell\": 10,\n \"per_unit\": false,\n \"description\": \"Standard entry ticket.\",\n \"tax_rate\": 15,\n \"configured_amount\": \"100.00\",\n \"amount_base\": \"100.00\",\n \"amount_service\": \"0.00\",\n \"amount_with_service\": \"100.00\",\n \"amount_tax\": \"15.00\",\n \"amount_with_tax\": \"115.00\",\n \"amount_total\": \"115.00\",\n \"amounts_by_payment_method\": {},\n \"quantity\": 100,\n \"tickets_count\": 0,\n \"is_out_stock\": false,\n \"request_assistant_information\": false,\n \"all_assistants_same_price\": false,\n \"assistant_fields\": {},\n \"questions\": [],\n \"has_discounts\": false,\n \"addons\": []\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Vouchers", "description": "", "item": [ { "name": "Register a ticket purchase intention for an event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:post_slug\/tickets", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:post_slug\/tickets", "variable": [ { "id": "post_slug", "key": "post_slug", "value": "summer-festival", "description": "The event slug." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "assistant[payment_method]", "value": "voucher", "type": "text", "description": "" }, { "key": "assistant[skip_otp]", "value": "", "type": "text", "description": "" }, { "key": "adds_accepted", "value": "1", "type": "text", "description": "Whether addons or additional terms were accepted." }, { "key": "require_tax", "value": "1", "type": "text", "description": "Whether tax is required." }, { "key": "tickets[0][is_main]", "value": "1", "type": "text", "description": "" }, { "key": "tickets[0][ticket_type_id]", "value": "1", "type": "text", "description": "" }, { "key": "tickets[0][quantity]", "value": "1", "type": "text", "description": "" }, { "key": "tickets[0][discount_code]", "value": "EARLYBIRD", "type": "text", "description": "" }, { "key": "tickets[0][name]", "value": "Jane Doe", "type": "text", "description": "" }, { "key": "tickets[0][email]", "value": "jane@example.com", "type": "text", "description": "" }, { "key": "tickets[0][phone]", "value": "+593999999999", "type": "text", "description": "" }, { "key": "tickets[0][identification_number]", "value": "0912345678", "type": "text", "description": "" }, { "key": "tickets[0][answers][1]", "value": "Vegetarian", "type": "text", "description": "" }, { "key": "tickets[0][answers][2]", "value": "No", "type": "text", "description": "" }, { "key": "tickets[0][seats][0][ticket_type_id]", "value": "1", "type": "text", "description": "" }, { "key": "tickets[0][seats][0][coordinate]", "value": "A-01", "type": "text", "description": "" }, { "key": "tickets[0][seats][0][label]", "value": "A1", "type": "text", "description": "" }, { "key": "tickets[0][addons][0][ticket_type_id]", "value": "1", "type": "text", "description": "" }, { "key": "tickets[0][addons][0][id]", "value": "1", "type": "text", "description": "" }, { "key": "tickets[0][addons][0][quantity]", "value": "1", "type": "text", "description": "" }, { "key": "invoice_data[name]", "value": "Jane Doe", "type": "text", "description": "" }, { "key": "invoice_data[identification_type]", "value": "05", "type": "text", "description": "" }, { "key": "invoice_data[identification_number]", "value": "0999999999001", "type": "text", "description": "" }, { "key": "invoice_data[address]", "value": "123 Main Street", "type": "text", "description": "" }, { "key": "invoice_data[email]", "value": "billing@example.com", "type": "text", "description": "" }, { "key": "invoice_data[phone]", "value": "+593999999999", "type": "text", "description": "" }, { "key": "assistant[voucher]", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Ticket created successfully\",\n \"data\": {\n \"order_hash\": \"65f1c9a7\",\n \"currency\": \"USD\",\n \"tickets_data\": [\n {\n \"hash\": \"4f2c8f2a6b8f4a3d9c8e7f6a5b4c3d2e\",\n \"amount\": 100,\n \"amount_with_tax\": 115,\n \"amount_tax\": 15,\n \"amount_payment_gateway\": 0,\n \"tax\": 15,\n \"discounts\": [],\n \"ticket_type\": {\n \"id\": 1,\n \"name\": \"General Admission\"\n },\n \"assistant\": {\n \"id\": 1,\n \"name\": \"Jane Doe\",\n \"email\": \"jane@example.com\"\n },\n \"is_main\": true,\n \"seat_coordinate\": null,\n \"seat_label\": null\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"Aforo m\u00e1ximo alcanzado para la localidad General Admission. Por favor, elige otra localidad o reduce la cantidad de tickets.\"}", "name": "" } ] }, { "name": "Send the voucher invitations by email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/vouchers\/:voucher_hash\/send-mail", "query": [], "raw": "{{baseUrl}}\/api\/posts\/vouchers\/:voucher_hash\/send-mail", "variable": [ { "id": "voucher_hash", "key": "voucher_hash", "value": "4f2c8f2a6b8f4a3d9c8e7f6a5b4c3d2e", "description": "The voucher hash." } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Mail sent successfully\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error occurred while sending the mail.\"}", "name": "" } ] }, { "name": "Validate the OTP associated with a voucher.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/vouchers\/:voucher_hash\/otp-validate", "query": [], "raw": "{{baseUrl}}\/api\/posts\/vouchers\/:voucher_hash\/otp-validate", "variable": [ { "id": "voucher_hash", "key": "voucher_hash", "value": "4f2c8f2a6b8f4a3d9c8e7f6a5b4c3d2e", "description": "The voucher hash." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"otp\":\"123456\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"OTP validated successfully\",\n \"data\": {\n \"order_hash\": \"4f2c8f2a6b8f4a3d9c8e7f6a5b4c3d2e\",\n \"currency\": \"USD\",\n \"event_name\": \"Summer Festival\",\n \"payment_data\": {\"method\": \"voucher\"},\n \"tickets_data\": [],\n \"addons\": []\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\"message\":\"The OTP entered is invalid.\"}", "name": "" } ] }, { "name": "Resend the OTP associated with a voucher.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/vouchers\/:voucher_hash\/retry-otp", "query": [], "raw": "{{baseUrl}}\/api\/posts\/vouchers\/:voucher_hash\/retry-otp", "variable": [ { "id": "voucher_hash", "key": "voucher_hash", "value": "4f2c8f2a6b8f4a3d9c8e7f6a5b4c3d2e", "description": "The voucher hash." } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"OTP resent successfully\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }