Skip to content

Design Studio Parameters

JaredPhelps edited this page Apr 14, 2015 · 1 revision
  • DesignerLocation - Example value: "http://images.inksoft.com/designer/html5"

    • This value indicates where the design studio code should be loaded from. Although this is sometimes the same as "Domain" or "SSLDomain", it can be anywhere. We recommend that it be a CDN location like http://images.inksoft.com/designer/html5 for optimal load time. However, sometimes it is necessary for this to be a subdomain of the hosting page for browser security reasons (ie, if we are going to need to forward to CartURL or NextURL later).
  • EnforceBoundaries - Example value: "1"

    • Determines whether or not the user can drag items outside the print region boundaries.
  • Background - Example value: "http://demo.inksoft.com/custombackground.png"

    • If Background is not blank and BackgroundColor is blank, sets the background-image of the design studio to a custom image.
  • VectorOnly - Available values: "true", "false"

    • If true, the user will not be allowed to upload a full-color raster photograph. They must upload a vector file or a raster file and select which colors they want.
  • Embroidery - Available values: "true", "false"

    • Reserved for future use
  • MaxScreenPrintColors - Example value: "12"

    • Determines how many colors the user can have in a design before they get a warning to reduce the number of colors. Also determines the number of colors they can reduce a raster image to when uploading a new image.
  • RoundPrices - Available values: "true", "false"

    • No longer in use
  • StoreID - Example value: "433"

    • Your Store's numeric ID - used for many API calls
  • PublisherID - Example value: "108"

    • Your main "fulfillment" store's ID. Used for API calls
  • SessionID

    • The user's session ID, if a session has already been created. Providing this ensures the design studio doesn't make any extraneous calls to get session information.
  • SessionToken

    • A guid session identifier. Like Session ID, used to avoid calling the server to create or get a session when one has already been created for the user.
  • UserID

    • A numeric value for the InkSoft user ID. If this is provided, the design studio will skip any log-in screens and save any art directly to the provided user's ID.
  • UserName - Example value: "FirstName LastName"

    • A string with the user's name. Used in the save and share screen to pre-fill the user name field for e-mailing a design.
  • UserEmail - Example value: ""

    • A string with the user's e-mail address. Used in the save and share screen to pre-fill the "from" e-mail field for e-mailing a design.
  • DesignID - Example value: "1234567890"

    • The design ID that the design studio should load and render on startup. Used if the user selected a design template to customize.
  • ProductID - Example value: "1080108"

    • The InkSoft product ID the design studio should start with. For most scenarios, this is required. If it is not provided, the design studio goes into "Art tools mode" with a blank canvas, no checkout, and a number of other features missing. You can use the GetProduct API call to search for a product by SKU to find a suitable value for this and ProductStyleID.
  • ProductStyleID - Example value: "3336495"

    • The InkSoft product style (color) ID the design studio should start with. If not provided, The design studio will use the default style.
  • DisableAddToCart - Available values: "true", "false"

    • If "true", the "Checkout" button is removed from the screen.
  • DisableUploadImage - Available values: "true", "false"

    • If "true", the "Upload Image" button is removed from the left navigation screen.
  • DisableClipArt - Available values: "true", "false"

    • If "true", the "Clip Art" button is removed from both the left navigation screen and the default greet box.
  • DisableUserArt - Available values: "true", "false"

    • If "true", the "My Saved Art" button is removed from both the left navigation screen and the default greet box.
  • DisableProducts - Available values: "true", "false"

    • If "true", the "Products" button is removed from the left navigation screen.
  • DisableDesigns - Available values: "true", "false"

    • If "true", the "Design Templates" button is removed from both the left navigation screen and the default greet box.
  • DisableDistress - Available values: "true", "false"

    • If "true", the "Distress Effects" button is removed from the left navigation screen.
  • DisableResolutionMeter - Available values: "true", "false"

    • If "true", the users will not see the green to red spectrum indicating raster image quality and dpi on the right side of the screen when editing a raster image.
  • DisableUploadVectorArt - Available values: "true", "false"

    • If "true", the users will not be allowed to upload any vector files.
  • DisableUploadRasterArt - Available values: "true", "false"

    • If "true", the users will not be allowed to upload any raster files.
  • StartPage - Example value: "Designs"

    • Used with StartPageCategoryID to open a particular designs category when the DS starts up. Currently the only supported non-blank value is "Designs".
  • StartPageCategoryID - Example value: "53239"

    • Used with StartPage to open a particular designs category when the DS starts up. Should have the category ID of a designs category.
  • ArtID - Example value: "1234567890"

    • Like DesignID, this indicates a piece of clip art the user would like to start with to create their design. Typically passed in when you have a custom clip art page and the user chooses to customize a particular piece of clip art.
  • Domain - Example value: "demo.inksoft.com"

    • The domain the design studio should use for API calls. Typically a subdomain of the hosted page, but can also be "stores.inksoft.com"
  • SSLEnabled - Available values: "true", "false"

    • If true, the design studio will make calls over SSL to the SSLDomain when necessary.
  • SSLDomain - Example value: "demo.inksoft.com"

    • If SSLEnabled is true, the design studio will make calls over SSL to the SSLDomain when necessary
  • StoreURI - Example value: "demo"

    • The identifier your store uses in its stores.inksoft.com URL. For example, if your store's InkSoft URL is http://stores.inksoft.com/yourtees/, then StoreURI is "yourtees". This is required for various API calls.
  • NextURL - Example value: "http://demo.inksoft.com/custompage.php?designID=0"

    • A URL to forward the user to after they SAVE a design. Used for certain kinds of integrations where a customer does not want any interaction with the InkSoft cart at all, preferring instead to customize the entire checkout experience. designID=0 is replaced with designID=1234567890 (only with a real design ID). You can then call GetDesign to get the product/product style the design was created on and construct the product/design image URL.
  • CartURL - Example value: "http://demo.inksoft.com/demo/Cart/{{SessionToken}}?SessionID={{SessionID}}&UserID={{UserID}}"

    • Like NextURL, but the user isn't forwarded until after they've selected sizes and quantities and all their information has been added to the InkSoft cart. Used for integrations where you want the design studio to prompt for some cart information, but then want to use the API to create your own custom cart checkout experience.
  • OrderSummary - Available values: "true", "false"

    • When false, the "Get Quote" button is hidden.
  • WelcomeScreen - Example value: "http://demo.inksoft.com/image.jpg"

    • Designates a static image to display in a modal popup when the designer first loads.
  • WelcomeVideo - Example value: ""

    • Designates a youtube video URL or or youtube ID of a video to play in a modal popup when the designer first loads.
  • GreetBoxSetting - Example value: "LANDING"

    • If "LANDING", shows the InkSoft Greet box after the designer loads.
  • AutoZoom - Available values: "true", "false"

    • When "true", after the user selects a design, the designer will zoom in after displaying it for two seconds.
  • EnableNameNumbers - Available values: "true", "false"

    • If "false", removes the Names and Numbers button on the left side navigation
  • AddThisPublisherId - Example value: "xa-4fccb0966fef0ba7"

    • Used for the AddThis plug-in that drives the "share via social media" functionality
  • EnableCartPricing - Available values: "true", "false"

    • When "false", all pricing is hidden in the cart
  • EnableCartCheckout - Available values: "true", "false"

    • When true, the user will NOT be forwarded to CartURL, and instead will be taken through the checkout process without leaving the design studio.
  • EnableCartShipping - Available values: "true", "false"

    • When and EnableCartCheckout is true, the user will be prompted for shipping information during checkout
  • PaymentDisabled - Available values: "true", "false"

    • If true and EnableCartCheckout is true, the user will not be prompted for payment information and the order will be placed as "Arrange Payment Later"
  • BillingAddressRequired - Available values: "true", "false"

    • If true and EnableCartCheckout is true, the user will be required to enter billing information during checkout. Otherwise, the user will be allowed to enter billing information but not required.
  • CurrencySymbol - Example value: "$"

    • The symbol used for all values that are displayed as currency (ie, in get quote and view cart pages).
  • HideProductPricing - Available values: "true", "false"

    • If true, no product pricing will be displayed when the user is browsing products.
  • BackgroundColor - Example value: "EEEEEE"

    • If filled in, sets the background color of the design studio.

Clone this wiki locally