{"id":"d3abf138-28da-4f7d-ab16-12d68a52a355","createdDate":"2023-07-30T12:42:45.378Z","updatedDate":"2023-07-30T12:42:45.378Z","resourceId":"6082d4c9-4782-414d-85ee-b30fff6795da","api":{"schema":{"object":{"displayName":"Script Properties Object","description":"","slug":"script-properties-object","$ref":"#/components/schemas/com.wixpress.market.aim.api.ScriptProperties","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/devcenter.git"},"methods":[{"summary":"Get Embedded Script","description":"Retrieves this app's existing embedded script parameters\nIf the app does not have an embed on the site, this endpoint will return 404","operationId":"com.wixpress.market.aim.api.EmbeddedScriptsService.GetEmbeddedScript","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.GetEmbeddedScriptResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/apps","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/apps","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.market.aim.api.EmbeddedScriptsService","errors":[],"exposure":"PUBLIC","permissions":["APPS.MANAGE_EMBEDDED_SCRIPT"],"externalPermissionScopes":[{"name":"Manage Embedded Scripts","scopeId":"SCOPE.DC-APPS.MANAGE-EMBEDDED-SCRIPTS"}],"protoArtifactId":"com.wixpress.market:app-instance-manager-api","serviceArtifactId":"com.wixpress.market.app-instance-manager-webapp","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.market.aim.api.GetEmbeddedScriptRequest","responseMessage":"com.wixpress.market.aim.api.GetEmbeddedScriptResponse"},"legacyExamples":[{"name":"GetEmbeddedScript","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/apps/v1/scripts \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"properties\": {\n \"parameters\": {\n \"KeyName123\": \"Value123\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/devcenter.git"},"httpMethod":"get","path":"/v1/scripts","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.market.aim.api.EmbeddedScriptsService","errors":[],"exposure":"PUBLIC","permissions":["APPS.MANAGE_EMBEDDED_SCRIPT"],"externalPermissionScopes":[{"name":"Manage Embedded Scripts","scopeId":"SCOPE.DC-APPS.MANAGE-EMBEDDED-SCRIPTS"}],"protoArtifactId":"com.wixpress.market:app-instance-manager-api","serviceArtifactId":"com.wixpress.market.app-instance-manager-webapp","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.market.aim.api.GetEmbeddedScriptRequest","responseMessage":"com.wixpress.market.aim.api.GetEmbeddedScriptResponse"},"legacyExamples":[{"name":"GetEmbeddedScript","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/apps/v1/scripts \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"properties\": {\n \"parameters\": {\n \"KeyName123\": \"Value123\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/devcenter.git","contentLink":{"displayName":"Get Embedded Script","slugifiedName":"get-embedded-script"},"permissionScopes":[{"name":"Manage Embedded Scripts","scopeId":"SCOPE.DC-APPS.MANAGE-EMBEDDED-SCRIPTS"}],"isAdminMethod":true},{"summary":"Embed Script","description":"Inject a script in an app with an existing embedded script component, with the given parameters. Key names must match exactly to the key names used in the app's embedded script","operationId":"com.wixpress.market.aim.api.EmbeddedScriptsService.EmbedScript","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.EmbedScriptResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/apps","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/apps","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"EmbedScriptRequest","description":"","properties":{"properties":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.ScriptProperties","summary":"properties","description":"Parameters to embed","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["properties"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.market.aim.api.EmbeddedScriptsService","errors":[],"exposure":"PUBLIC","permissions":["APPS.MANAGE_EMBEDDED_SCRIPT"],"externalPermissionScopes":[{"name":"Manage Embedded Scripts","scopeId":"SCOPE.DC-APPS.MANAGE-EMBEDDED-SCRIPTS"}],"protoArtifactId":"com.wixpress.market:app-instance-manager-api","serviceArtifactId":"com.wixpress.market.app-instance-manager-webapp","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.market.aim.api.EmbedScriptRequest","responseMessage":"com.wixpress.market.aim.api.EmbedScriptResponse"},"legacyExamples":[{"name":"EmbedScript","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/apps/v1/scripts \\\n -H 'Authorization: ' \\\n -d '{\n \"properties\": {\n \"parameters\": {\n \"KeyName123\": \"Value123\"\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"properties\": {\n \"parameters\": {\n \"KeyName123\": \"Value123\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/devcenter.git"},"httpMethod":"post","path":"/v1/scripts","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.market.aim.api.EmbeddedScriptsService","errors":[],"exposure":"PUBLIC","permissions":["APPS.MANAGE_EMBEDDED_SCRIPT"],"externalPermissionScopes":[{"name":"Manage Embedded Scripts","scopeId":"SCOPE.DC-APPS.MANAGE-EMBEDDED-SCRIPTS"}],"protoArtifactId":"com.wixpress.market:app-instance-manager-api","serviceArtifactId":"com.wixpress.market.app-instance-manager-webapp","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.market.aim.api.EmbedScriptRequest","responseMessage":"com.wixpress.market.aim.api.EmbedScriptResponse"},"legacyExamples":[{"name":"EmbedScript","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://www.wixapis.com/apps/v1/scripts \\\n -H 'Authorization: ' \\\n -d '{\n \"properties\": {\n \"parameters\": {\n \"KeyName123\": \"Value123\"\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"properties\": {\n \"parameters\": {\n \"KeyName123\": \"Value123\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/devcenter.git","contentLink":{"displayName":"Embed Script","slugifiedName":"embed-script"},"permissionScopes":[{"name":"Manage Embedded Scripts","scopeId":"SCOPE.DC-APPS.MANAGE-EMBEDDED-SCRIPTS"}],"isAdminMethod":true}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Embedded Script API\n\nUse this API to inject custom script tags to the head tag of your users' websites.\n\n

\n
\n Important:
\n The keys in the custom parameters passed in this API must be identical to the keys defined in the app's embedded script component. Using any other keys results in a 400 error: \"Parameters map sent to embedded script is not the same as discovered in the script code\".\n
\n

\n\nFor more information, see [About the Embedded Script API](https://devforum.wix.com/en/article/about-embedded-script-components).\n","sourceRepo":"git@github.com:wix-private/devcenter.git","path":"docs/EmbeddedScripts.md"}],"components":{"schemas":{"com.wixpress.market.aim.api.ScriptProperties":{"type":"object","properties":{"parameters":{"title":"parameters","description":"Script parameters","type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}},"disabled":{"title":"disabled","description":"Whether script is disabled or not, defaults to false (not disabled)","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ScriptProperties","description":"Embedded script data"},"com.wixpress.market.aim.api.EmbedScriptRequest":{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.ScriptProperties","summary":"properties","description":"Parameters to embed","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EmbedScriptRequest","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.market.aim.api.EmbedScriptResponse":{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.ScriptProperties","summary":"properties","description":"Script instance on this website","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EmbedScriptResponse","description":""},"com.wixpress.market.aim.api.GetEmbeddedScriptRequest":{"type":"object","properties":{},"title":"GetEmbeddedScriptRequest","description":""},"com.wixpress.market.aim.api.GetEmbeddedScriptResponse":{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.ScriptProperties","summary":"properties","description":"Script instance on this website","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetEmbeddedScriptResponse","description":""},"com.wixpress.market.aim.api.EmbedScriptByInstanceIdRequest":{"type":"object","properties":{"instanceId":{"title":"instanceId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"properties":{"$ref":"#/components/schemas/com.wixpress.market.aim.api.ScriptProperties","summary":"properties","description":"Parameters to embed","x-wix-docs":{"exposure":"PUBLIC"}},"componentId":{"title":"componentId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EmbedScriptByInstanceIdRequest","description":""},"com.wixpress.market.aim.api.GetEmbeddedScriptByInstanceIdRequest":{"type":"object","properties":{"instanceId":{"title":"instanceId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"componentId":{"title":"componentId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetEmbeddedScriptByInstanceIdRequest","description":""}}},"title":"Script Properties","description":"","fqdn":"wix.devcenter.scripts.v1.script_properties"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Embedded Script API\n\nUse this API to inject custom script tags to the head tag of your users' websites.\n\n

\n
\n Important:
\n The keys in the custom parameters passed in this API must be identical to the keys defined in the app's embedded script component. Using any other keys results in a 400 error: \"Parameters map sent to embedded script is not the same as discovered in the script code\".\n
\n

\n\nFor more information, see [About the Embedded Script API](https://devforum.wix.com/en/article/about-embedded-script-components).\n"}]},"reviewStatus":"APPROVED","isLocked":true}