{ "openapi": "3.1.0", "info": { "title": "QR Codes", "version": "2.0.0", "description": "Crie, personalize, atualize e baixe QR Codes com as mesmas opções visuais do editor.\nUse Authorization: Bearer SUA_CHAVE em todas as chamadas. Obtenha ou renove a chave em Minha conta → API. Exige API ativa no plano, assinatura válida e permissão para o tipo de QR Code. A renovação invalida a chave anterior. Nunca exponha a chave no navegador de visitantes.\nLimite: 60 requisições por minuto por chave. Confira X-RateLimit-Limit, X-RateLimit-Remaining e Retry-After em respostas 429. A criação respeita a quantidade de QR Codes do plano." }, "servers": [ { "url": "https://gerarqrcode.online/api" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "paths": { "/qr-codes": { "get": { "summary": "Listar: page ≥ 1 e results_per_page de 1 a 100 (padrão 25).", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "results_per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ] }, "post": { "summary": "Criar: name, type e os campos obrigatórios do tipo.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "default": "none" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" } }, "required": [ "name", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "default": "none" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" } }, "required": [ "name", "type" ] } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "format": "binary" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" }, "pdf_file": { "type": "string", "format": "binary", "description": "PDF: envie pdf_file via multipart, até 104.857.600 bytes (100 MB). Exige a permissão exclusiva de PDF. O documento fica público pelo endereço com UUID. Na edição, reenviar pdf_file troca o documento mantendo o endereço. Não envie url para escolher o endereço de um PDF." }, "qr_code_logo": { "type": "string", "format": "binary", "description": "Para logo próprio, envie qr_code_logo como arquivo ou logo como data URI base64. Para fundo, envie bg_image como arquivo ou data URI e use use_image_background=true. Aceitos: PNG, JPEG, GIF, WebP e SVG sanitizado, até 500.000 bytes por imagem; imagens raster até 4096 × 4096 px. URLs remotas e caminhos arbitrários não são aceitos. Para logo pronto, use um nome retornado por GET /api/qr-codes/options em logo." } }, "required": [ "name", "type" ] } } } } } }, "/qr-codes/options": { "get": { "summary": "Consultar tipos, estilos, olhos, molduras, fontes, logos, padrões e limites atuais.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } } } }, "/qr-codes/{uuid}": { "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Consultar o QR Code e suas configurações.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } } }, "post": { "summary": "Editar conteúdo, personalização, nome, projeto ou substituir o PDF.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "default": "none" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "default": "none" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" } } } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "format": "binary" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" }, "pdf_file": { "type": "string", "format": "binary", "description": "PDF: envie pdf_file via multipart, até 104.857.600 bytes (100 MB). Exige a permissão exclusiva de PDF. O documento fica público pelo endereço com UUID. Na edição, reenviar pdf_file troca o documento mantendo o endereço. Não envie url para escolher o endereço de um PDF." }, "qr_code_logo": { "type": "string", "format": "binary", "description": "Para logo próprio, envie qr_code_logo como arquivo ou logo como data URI base64. Para fundo, envie bg_image como arquivo ou data URI e use use_image_background=true. Aceitos: PNG, JPEG, GIF, WebP e SVG sanitizado, até 500.000 bytes por imagem; imagens raster até 4096 × 4096 px. URLs remotas e caminhos arbitrários não são aceitos. Para logo pronto, use um nome retornado por GET /api/qr-codes/options em logo." } } } } } } }, "patch": { "summary": "Editar conteúdo, personalização, nome, projeto ou substituir o PDF.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "background_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "background_color_transparency": { "type": "number", "default": 0, "minimum": 0, "maximum": 100 }, "bg_image": { "type": "string", "default": "none" }, "chave_pix": { "type": "string", "default": "", "maxLength": 2048 }, "cidade_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_address": { "type": "string", "default": "", "maxLength": 2048 }, "crypto_amount": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "crypto_coin": { "type": "string", "default": "bitcoin", "maxLength": 2048, "enum": [ "bitcoin", "ethereum", "elrond" ] }, "custom_eyes_color": { "type": "boolean", "default": false }, "descricao_pix": { "type": "string", "default": "", "maxLength": 2048 }, "different_eyes_color": { "type": "boolean", "default": false }, "ecc": { "type": "string", "default": "M", "maxLength": 2048, "enum": [ "L", "M", "Q", "H" ] }, "email": { "type": "string", "default": "", "maxLength": 2048 }, "email_body": { "type": "string", "default": "", "maxLength": 2048 }, "email_subject": { "type": "string", "default": "", "maxLength": 2048 }, "event": { "type": "string", "default": "", "maxLength": 2048 }, "event_end_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_location": { "type": "string", "default": "", "maxLength": 2048 }, "event_note": { "type": "string", "default": "", "maxLength": 2048 }, "event_start_datetime": { "type": "string", "default": "", "maxLength": 2048 }, "event_timezone": { "type": "string", "default": "UTC", "maxLength": 2048 }, "event_url": { "type": "string", "default": "", "maxLength": 2048 }, "eyes_inner_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_inner_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_bottom_left_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "eyes_outer_top_right_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "facetime": { "type": "string", "default": "", "maxLength": 2048 }, "foreground_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_one": { "type": "string", "default": "#000000", "maxLength": 2048 }, "foreground_gradient_style": { "type": "string", "default": "vertical", "maxLength": 2048, "enum": [ "vertical", "horizontal", "diagonal", "inverse_diagonal", "radial" ] }, "foreground_gradient_two": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "foreground_type": { "type": "string", "default": "color", "maxLength": 2048, "enum": [ "color", "gradient" ] }, "frame": { "type": "string", "default": "none", "maxLength": 2048, "enum": [ "none", "bottom", "top", "balloon-bottom", "balloon-top", "ribbon-bottom", "ribbon-top", "phone", "cine" ] }, "frame_color": { "type": "string", "default": "#000000", "maxLength": 2048 }, "frame_text": { "type": "string", "default": "", "maxLength": 2048 }, "frame_text_color": { "type": "string", "default": "#FFFFFF", "maxLength": 2048 }, "frame_text_font": { "type": "string", "default": "Organo.svg", "maxLength": 2048, "enum": [ "Organo.svg", "GhostFestival.svg", "Always-In-My-Heart.svg", "AmaticSC-Regular.svg", "angelina.svg", "Cookie-Regular.svg", "Coppint-Medium.svg", "degrassi.svg", "Emilia.svg", "GrandHotel-Regular.svg", "HomemadeApple.svg", "LuckiestGuy.svg", "Marlboro.svg", "Montserrat-Regular.svg", "OpenSans-Regular.svg", "Orbitron-Regular.svg", "PoiretOne-Regular.svg", "RalewayDots-Regular.svg", "theboldfont.svg" ] }, "frame_text_size": { "type": "number", "default": 100, "minimum": 10, "maximum": 100 }, "harmonize_background": { "type": "boolean", "default": false }, "location_latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "location_longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "logo": { "type": "string", "default": "none" }, "margin": { "type": "number", "default": 2, "minimum": 0, "maximum": 25 }, "marker_in": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "marker_out": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "dropeyeleft", "dropeyeleaf", "dropeyeright", "squarecircle", "circle", "rounded", "flower", "flower_in", "leaf", "3-corners", "vortex", "dots", "bruised", "canvas" ] }, "nome_beneficiario": { "type": "string", "default": "", "maxLength": 2048 }, "pattern": { "type": "string", "default": "default", "maxLength": 2048, "enum": [ "default", "flurry", "sdoz", "drop_in", "drop", "dropeye", "circle", "dot", "rounded", "sun", "star", "diamond", "sparkle", "danger", "cross", "plus", "x", "heart", "shake", "blob", "special-circle-orizz", "special-circle-vert", "special-circle", "special-diamond", "ribbon", "oriental", "ellipse", "vortex", "sparkle_dot", "9-dots", "9-dots-fat", "flower", "elastic", "diagonal", "ropes", "ropes-vert", "bruised" ] }, "paypal_cancel_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_currency": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_email": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_price": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "paypal_thank_you_url": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_title": { "type": "string", "default": "", "maxLength": 2048 }, "paypal_type": { "type": "string", "default": "buy_now", "maxLength": 2048, "enum": [ "buy_now", "add_to_cart", "donation" ] }, "phone": { "type": "string", "default": "", "maxLength": 2048 }, "qr_code_logo_size": { "type": "number", "default": 100, "minimum": 30, "maximum": 100 }, "remove_margin": { "type": "boolean", "default": false }, "size": { "type": "number", "default": 500, "minimum": 200, "maximum": 800 }, "sms": { "type": "string", "default": "", "maxLength": 2048 }, "sms_body": { "type": "string", "default": "", "maxLength": 2048 }, "text": { "type": "string", "default": "", "maxLength": 2048 }, "type": { "type": "string", "default": "texto", "maxLength": 2048, "enum": [ "texto", "url", "pdf", "telefone", "sms", "email", "whatsapp", "facetime", "localizacao", "wifi", "evento", "criptomoeda", "vcard", "paypal", "pix-estatico" ] }, "url": { "type": "string", "default": "", "maxLength": 2048 }, "use_image_background": { "type": "boolean", "default": false }, "valor_pix": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "vcard_birthday": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_city": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_company": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_country": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_email": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_first_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_job_title": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_last_name": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_note": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_phone_numbers": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_region": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_social_label": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_social_value": { "type": "array", "default": [], "items": { "type": "string", "maxLength": 1024 }, "maxItems": 20 }, "vcard_street": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_url": { "type": "string", "default": "", "maxLength": 2048 }, "vcard_zip": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp": { "type": "string", "default": "", "maxLength": 2048 }, "whatsapp_body": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_encryption": { "type": "string", "default": "nopass", "maxLength": 2048, "enum": [ "nopass", "WEP", "WPA/WPA2" ] }, "wifi_is_hidden": { "type": "boolean", "default": false }, "wifi_password": { "type": "string", "default": "", "maxLength": 2048 }, "wifi_ssid": { "type": "string", "default": "", "maxLength": 2048 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "link_id": { "type": [ "string", "null" ], "format": "uuid" }, "url_dynamic": { "type": "boolean" } } } } } } }, "delete": { "summary": "Excluir o QR Code e seus arquivos.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } } } }, "/qr-codes/{uuid}/readability": { "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Avaliar legibilidade: nota 0–100, cor, leitura confirmada e mensagem. É uma estimativa de qualidade, não uma probabilidade de leitura.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } } } }, "/qr-codes/{uuid}/download": { "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Baixar: ?format=svg|png|jpg|webp. Padrão: svg. A imagem usa o tamanho salvo; JPG recebe fundo branco quando necessário.", "responses": { "200": { "description": "Success: {data: ...}" }, "201": { "description": "Success: {data: ...}" }, "400": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "401": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "403": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "404": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "405": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "413": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "415": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "422": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "429": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "500": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." }, "503": { "description": "400 JSON inválido; 401 chave ausente/inválida ou sem acesso à API; 403 permissão, assinatura ou limite do plano; 404 recurso inexistente/de outra conta; 405 método; 413 requisição acima do limite; 415 formato de requisição; 422 campo/arquivo inválido; 429 limite de requisições; 500 falha ao salvar/exportar; 503 API desligada. Erros usam {\"errors\":[{\"title\":\"...\",\"status\":422}]}." } }, "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "svg", "png", "jpg", "webp" ], "default": "svg" } } ] } } }, "x-required-fields-by-type": { "texto": [ "text" ], "url": [ "url" ], "pdf": [ "pdf_file" ], "telefone": [ "phone" ], "sms": [ "sms" ], "email": [ "email" ], "whatsapp": [ "whatsapp" ], "facetime": [ "facetime" ], "localizacao": [ "location_latitude", "location_longitude" ], "wifi": [ "wifi_ssid" ], "evento": [ "event", "event_start_datetime" ], "criptomoeda": [ "crypto_address" ], "vcard": [], "paypal": [ "paypal_email", "paypal_title", "paypal_currency" ], "pix-estatico": [ "chave_pix", "nome_beneficiario", "cidade_beneficiario" ] } }