Understanding Product Smartlink Formats

Understanding Product Smartlink Formats

Every product in the Gateway CPP Database has its own unique URL that controls its functionality. Detailed below is an explanation of how URLs are structured. Software developers should also consult our Personalise-iT iFrame integration guide.


Base URL Customisable Product

http://app.gateway3d.com/acp/app/?l=acp2&c=x1ar86422u67zqn#p=XXXXXX&r=2d-canvas

Variable

Name

Description

Examples

p ps, pj or su*

Customisable, POD or Sample Product

Used to specify initial product / saved sample to display- CPP ID Number, Sample ID or Previous Print Job ID

&p=1032682

l*

Layout

Used to decide which interface to display - options

&l=acp

r*

Renderer

Controls which renderer should be loaded by the app, for example WebGL or Flash for 3D products and HTML5 Canvas for 2D products.


Not all apps support every renderer.

&r=2d-canvas

&r=flash

&r=webgl

&r=multi

guid*

Company Ref

Company ID so artwork goes to the correct fulfilment partner

&guid=99999

c

Layout Configuration

Used to decide how the layout is configured in more detail - covering tab order, enhanced features etc

&c=9knv3zpt43culea

lo

Locale

Use to set a different language - can also be used to change terminology in your own language - if not selected will display in English

&lo=

g

Gallery

Use if you want to enable the gallery tab and link to an image gallery

&g=

pc

Product Category

Use to add product categories if you are using the product selector

&pc=

epa

External Pricing API

Use to specify location of pricing, product name / description and minimum order values

&epa=

ep3dUrl

Add to Cart Callback

Use to specify payment details for facebook app or if not integrate with an ecommerce website

&ep3dUrl=

text

  Auto Add Text  Auto adds text to a product  &text=yourtext

i

Auto Upload Image from URL

Use to load a product with an image or images auto applied to the image area. Image should be from a publically available url

&i=

ddp

 Dynamic Design Product  Will upload a product with a dynamic design already applied  &ddp=

dd

 Dynamic Design Will upload a range of dynamic designs for selection against a product  &dd=

ca

Auto Load with Certain Colour

Use to load a product with a certain colour already displayed

&ca=0xHexValue

aspect_name

 Load product with specified view

Use to load a product already in a certain print position 

&aspect_name=Back
_usePs
Use product state
Use the newer method of print job creation and generation.  Set to 1 (true) or 0 (false).
&_usePs=1
_pav
Personalisation App Version
The version number of the app being used 
&_pav

    *     = Required

 

Base URL for Sample, Print Job or Print On Demand  Product

 

As above but su= or pj= replaces p=

Every product you create and save using personalise-it will have a unique su id / previous orders have a pj id

 

There are 3 basic types of product

 

  1. Sample that can be personalised

https://my.gateway3d.com/acp/app/?l=acp&su=63972&guid=99999&r=2d-canvas

 

  1. Print on Demand Product that is not personalised

https://my.gateway3d.com/acp/app/?l=acp&su=63972&c=114x4s3k8k820lk&guid=99999&r=2d-canvas

 

Print on Demand Products can also be displayed as a normal thumbnail only if sizes are handled on the website and colour changes are not required - as long as the sample/print on demand reference is passed to our print manager once an order has been paid for

 

Example Thumbnail

https://my.gateway3d.com/ep/output/thumbnails/samples/63972.jpg

 

  1. Print Jobs - Artwork from previous orders that can be re-ordered



URL Format for Apps Delivered via CDN

 

The URL format for apps delivered by the CDN is slightly different to a normal PERSONALISE-iT App (The CDN is used for apps that are international and are likely to have a high volume of traffic)

 

The URLs are structured like this

http://app.gateway3d.com/acp/app/? - uses app.gateway3d.com rather than my.gateway3d.com

l=acp2 - only the layout and language if used are detailed before the # - as these are both stored on the CDN

 

# - everything after the # is still pulled initially from the local server

p=1027692 - product ID is cache for common products increasing speed

guid=99999 - fulfilment company

 

Any other variables can be added just like an app from a local server by adding &

Here is the full URL - http://app.gateway3d.com/acp/app/?l=acp2#p=1027692&guid=99999&r=2d-canvas

    • Related Articles

    • Smartlink Apps | Ceres

      Introduction The following article has been written to detail how our standard Ceres app can be set up and used for. We have also detailed all of the available options associated with Ceres features, styling, renderer option and miscellaneous menus. ...

    • Smartlink Apps | ACP3_2

      Introduction The following article has been written to detail how our standard ACP 3_2 app can be set up and used for. We have also detailed all of the available features associated with ACP 3_2 features, styling, renderer option and miscellaneous ...

    • Smartlink Apps | Eris

      Introduction The following article has been written to detail how our standard Eris app can be set up and used for. We have also detailed all of the available options associated with Eris General, Miscellaneous and Image menus. This app has similar ...

    • Smartlink Apps | 3Column3

      Introduction The following article has been written to detail how our standard 3Column3 app can be set up and used for. We have also detailed all of the available options associated with 3Column3 features, styling, product info, renderer option and ...

    • Smartlink Apps | Proof3

      Introduction The following article has been written to detail how our standard Proof 3 app can be set up and used for. We have also detailed all of the available features associated with Proof 3 features. This app is designed for the B2B market and ...