[{"data":1,"prerenderedAt":504},["ShallowReactive",2],{"navigation":3,"\u002Fusing-cirrus-reader-studio\u002Fputting-a-reader-instance-on-your-website":105,"\u002Fusing-cirrus-reader-studio\u002Fputting-a-reader-instance-on-your-website-surround":501},[4,8,26,39,84],{"title":5,"path":6,"stem":7},"About this manual","\u002Fabout-this-manual","01.about-this-manual",{"title":9,"icon":10,"path":11,"stem":12,"children":13,"page":10},"Part 1: Understanding Cirrus Reader Studio",false,"\u002Funderstanding-cirrus-reader-studio","02.understanding-cirrus-reader-studio",[14,18,22],{"title":15,"path":16,"stem":17},"1. What Cirrus Reader Studio does","\u002Funderstanding-cirrus-reader-studio\u002Fwhat-cirrus-reader-studio-does","02.understanding-cirrus-reader-studio\u002F01.what-cirrus-reader-studio-does",{"title":19,"path":20,"stem":21},"2. Key concepts","\u002Funderstanding-cirrus-reader-studio\u002Fkey-concepts","02.understanding-cirrus-reader-studio\u002F02.key-concepts",{"title":23,"path":24,"stem":25},"3. Finding your way around","\u002Funderstanding-cirrus-reader-studio\u002Ffinding-your-way-around","02.understanding-cirrus-reader-studio\u002F03.finding-your-way-around",{"title":27,"icon":10,"path":28,"stem":29,"children":30,"page":10},"Part 2: Getting started","\u002Fgetting-started","03.getting-started",[31,35],{"title":32,"path":33,"stem":34},"4. Signing in and setting up","\u002Fgetting-started\u002Fsigning-in-and-setting-up","03.getting-started\u002F01.signing-in-and-setting-up",{"title":36,"path":37,"stem":38},"5. Quick start: your first publication on your website","\u002Fgetting-started\u002Fquick-start-your-first-publication-on-your-website","03.getting-started\u002F02.quick-start-your-first-publication-on-your-website",{"title":40,"icon":10,"path":41,"stem":42,"children":43,"page":10},"Part 3: Using Cirrus Reader Studio","\u002Fusing-cirrus-reader-studio","04.using-cirrus-reader-studio",[44,48,52,56,60,64,68,72,76,80],{"title":45,"path":46,"stem":47},"6. Dashboard","\u002Fusing-cirrus-reader-studio\u002Fdashboard","04.using-cirrus-reader-studio\u002F01.dashboard",{"title":49,"path":50,"stem":51},"7. Catalogue: publications","\u002Fusing-cirrus-reader-studio\u002Fcatalogue-publications","04.using-cirrus-reader-studio\u002F02.catalogue-publications",{"title":53,"path":54,"stem":55},"8. Catalogue: collections","\u002Fusing-cirrus-reader-studio\u002Fcatalogue-collections","04.using-cirrus-reader-studio\u002F03.catalogue-collections",{"title":57,"path":58,"stem":59},"9. Reader Instances","\u002Fusing-cirrus-reader-studio\u002Freader-instances","04.using-cirrus-reader-studio\u002F04.reader-instances",{"title":61,"path":62,"stem":63},"10. Putting a Reader Instance on your website","\u002Fusing-cirrus-reader-studio\u002Fputting-a-reader-instance-on-your-website","04.using-cirrus-reader-studio\u002F05.putting-a-reader-instance-on-your-website",{"title":65,"path":66,"stem":67},"11. Domains","\u002Fusing-cirrus-reader-studio\u002Fdomains","04.using-cirrus-reader-studio\u002F06.domains",{"title":69,"path":70,"stem":71},"12. Resource Manager","\u002Fusing-cirrus-reader-studio\u002Fresource-manager","04.using-cirrus-reader-studio\u002F07.resource-manager",{"title":73,"path":74,"stem":75},"13. Reader Users","\u002Fusing-cirrus-reader-studio\u002Freader-users","04.using-cirrus-reader-studio\u002F08.reader-users",{"title":77,"path":78,"stem":79},"14. Integrations","\u002Fusing-cirrus-reader-studio\u002Fintegrations","04.using-cirrus-reader-studio\u002F09.integrations",{"title":81,"path":82,"stem":83},"15. Settings","\u002Fusing-cirrus-reader-studio\u002Fsettings","04.using-cirrus-reader-studio\u002F10.settings",{"title":85,"icon":10,"path":86,"stem":87,"children":88,"page":10},"Part 4: Reference","\u002Freference","05.reference",[89,93,97,101],{"title":90,"path":91,"stem":92},"16. Troubleshooting and common questions","\u002Freference\u002Ftroubleshooting-and-common-questions","05.reference\u002F01.troubleshooting-and-common-questions",{"title":94,"path":95,"stem":96},"17. Limits and file types at a glance","\u002Freference\u002Flimits-and-file-types-at-a-glance","05.reference\u002F02.limits-and-file-types-at-a-glance",{"title":98,"path":99,"stem":100},"18. Glossary","\u002Freference\u002Fglossary","05.reference\u002F03.glossary",{"title":102,"path":103,"stem":104},"19. Getting help","\u002Freference\u002Fgetting-help","05.reference\u002F04.getting-help",{"id":106,"title":61,"body":107,"description":484,"extension":496,"meta":497,"navigation":388,"path":62,"seo":498,"stem":63,"__hash__":500},"docs\u002F04.using-cirrus-reader-studio\u002F05.putting-a-reader-instance-on-your-website.md",{"type":108,"value":109,"toc":483},"minimark",[110,119,124,127,177,181,204,211,218,222,228,234,249,255,261,281,298,301,307,311,322,326,344,348,354,357,373,377,441,445,448],[111,112,113,114,118],"p",{},"To show a Reader Instance on your website, you give your web team a short piece of code, the ",[115,116,117],"em",{},"embed code",". This chapter explains how to get it and what to give them. You do not need to understand the code yourself.",[120,121,123],"h2",{"id":122},"_101-before-you-start","10.1 Before you start",[111,125,126],{},"Check these three things first:",[128,129,130,152,166],"ol",{},[131,132,133,137,138,142,143,146,147,151],"li",{},[134,135,136],"strong",{},"Your website is a permitted domain"," of the Reader Instance. See ",[139,140,141],"a",{"href":66},"Domains"," and the ",[134,144,145],{},"Permitted Domains"," setting in ",[139,148,150],{"href":149},"\u002Fusing-cirrus-reader-studio\u002Freader-instances#details-tab","Create or edit an instance",". If your site is not on the list, the Reader Embed will not appear there. If the list is empty, any website can show it.",[131,153,154,157,158,161,162,165],{},[134,155,156],{},"The publication is Live",", and you know its Publication ID (",[134,159,160],{},"⋮"," → ",[134,163,164],{},"Copy Publication Id"," in the Catalogue).",[131,167,168,171,172,176],{},[134,169,170],{},"If the instance uses Pre Authentication",", you have an ",[139,173,175],{"href":174},"\u002Fusing-cirrus-reader-studio\u002Fintegrations#_141-api-keys","API key"," ready for your web team.",[120,178,180],{"id":179},"_102-open-the-embed-dialog","10.2 Open the Embed dialog",[128,182,183,190],{},[131,184,185,186,189],{},"Go to ",[134,187,188],{},"Reader Instances",".",[131,191,192,193,195,196,199,200,203],{},"Open the ",[134,194,160],{}," menu of the instance you want and choose ",[134,197,198],{},"Embed",". (You can also click ",[134,201,202],{},"Generate Embed Code"," straight after creating a new instance.)",[111,205,206,207,210],{},"The ",[134,208,209],{},"Embed Reader"," dialog opens.",[111,212,213],{},[214,215],"img",{"alt":216,"src":217},"The Embed Reader dialog","\u002Fimages\u002F16-embed-dialog.png",[120,219,221],{"id":220},"_103-choose-how-the-publication-is-picked","10.3 Choose how the publication is picked",[111,223,206,224,227],{},[134,225,226],{},"Configuration Type"," decides how the Reader Embed knows which publication to show.",[111,229,230,233],{},[134,231,232],{},"Script Configuration"," (the default). Use this when a page always shows the same publication.",[235,236,237,243],"ul",{},[131,238,239,242],{},[134,240,241],{},"Publication ID",": search for the publication by name, or paste its ID.",[131,244,245,248],{},[134,246,247],{},"User ID",": optional. A unique identifier for the person reading, such as their customer number. \"We recommend a unique User ID per reader to assist with analytics.\" Your web team will usually fill this in automatically for each visitor, so you can leave it empty here.",[111,250,251,254],{},[134,252,253],{},"URL Query Parameters."," Use this when one page should show different publications depending on its web address. The publication (and, optionally, the person reading) is named in the address itself, for example:",[111,256,257],{},[258,259,260],"code",{},"https:\u002F\u002Fmywebsite.com\u002Freader?publication=publication-id&user=my-user-id",[235,262,263,272],{},[131,264,265,268,269,189],{},[134,266,267],{},"Publication Parameter",": the name used in the address for the publication, for example ",[258,270,271],{},"publication",[131,273,274,277,278,189],{},[134,275,276],{},"User Parameter",": the name used in the address for the person reading, for example ",[258,279,280],{},"user",[111,282,283,284,286,287,289,290,293,294,297],{},"In this address, ",[258,285,271],{}," and ",[258,288,280],{}," are the ",[115,291,292],{},"parameter names",". The parts after each ",[258,295,296],{},"="," are the actual publication ID and user ID; your website fills those in for each page. You only choose the names.",[111,299,300],{},"Cirrus Reader Studio shows an example address as you type.",[111,302,303],{},[214,304],{"alt":305,"src":306},"The URL Query Parameters option, with an example address","\u002Fimages\u002F17-embed-url-parameters.png",[120,308,310],{"id":309},"_104-copy-the-code","10.4 Copy the code",[111,312,313,314,317,318,321],{},"The grey box shows the code. Click ",[134,315,316],{},"Copy Code"," to copy it, then paste it into an email or message to your web team. Click ",[134,319,320],{},"Close"," when you have finished.",[120,323,325],{"id":324},"_105-pre-authentication","10.5 Pre-Authentication",[111,327,328,329,332,333,336,337,340,341,343],{},"If the instance's ",[139,330,331],{"href":149},"security level"," is ",[134,334,335],{},"Pre Authentication",", the dialog also shows an example of the request your website's server must send to Cirrus to start each reading session. Click ",[134,338,339],{},"Copy Token Request"," and include it with the embed code. Your web team will need an ",[139,342,175],{"href":174}," to make this request.",[120,345,347],{"id":346},"_106-re-copy-the-code-after-every-change","10.6 Re-copy the code after every change",[111,349,350,351],{},"The embed code includes the version of the Reader Instance's design. ",[134,352,353],{},"Each time you save the Reader Instance, the version changes.",[111,355,356],{},"After you change and save a Reader Instance that is already on your website:",[128,358,359,365,370],{},[131,360,361,362,364],{},"Open ",[134,363,198],{}," for that instance again.",[131,366,367,368,189],{},"Click ",[134,369,316],{},[131,371,372],{},"Send the new code to your web team and ask them to replace the old code with it.",[120,374,376],{"id":375},"_107-before-you-go-live-checklist","10.7 Before you go live: checklist",[235,378,381,394,403,413,422,431],{"className":379},[380],"contains-task-list",[131,382,385,390,391,189],{"className":383},[384],"task-list-item",[386,387],"input",{"disabled":388,"type":389},true,"checkbox"," The publication is ",[134,392,393],{},"Live",[131,395,397,399,400,402],{"className":396},[384],[386,398],{"disabled":388,"type":389}," Your website's domain is listed under ",[134,401,145],{}," for this instance.",[131,404,406,408,409,412],{"className":405},[384],[386,407],{"disabled":388,"type":389}," You have saved all changes to the instance ",[115,410,411],{},"before"," copying the code.",[131,414,416,418,419,421],{"className":415},[384],[386,417],{"disabled":388,"type":389}," If you use ",[134,420,335],{},", your web team has an API key and the token request.",[131,423,425,427,428,430],{"className":424},[384],[386,426],{"disabled":388,"type":389}," Your web team knows which ",[134,429,247],{}," to pass for each reader (recommended for statistics).",[131,432,434,436,437,440],{"className":433},[384],[386,435],{"disabled":388,"type":389}," You have tested the page yourself, and you can see yourself under ",[134,438,439],{},"Reader Users"," afterwards.",[120,442,444],{"id":443},"_108-what-to-send-your-web-team","10.8 What to send your web team",[111,446,447],{},"Send them:",[128,449,450,458,461,464,476],{},[131,451,206,452,454,455,457],{},[134,453,117],{}," (from ",[134,456,316],{},").",[131,459,460],{},"Where on the website it should go, and which publication(s) it should show.",[131,462,463],{},"If you use URL Query Parameters: the parameter names you chose.",[131,465,466,467,454,470,472,473,475],{},"If you use Pre Authentication: the ",[134,468,469],{},"token request",[134,471,339],{},") and an ",[134,474,175],{},". Send the key securely, not by ordinary email.",[131,477,478,479,482],{},"A link to the developer documentation, ",[134,480,481],{},"docs.cirrusreader.com",", which explains the technical details.",{"title":484,"searchDepth":485,"depth":486,"links":487},"",1,2,[488,489,490,491,492,493,494,495],{"id":122,"depth":486,"text":123},{"id":179,"depth":486,"text":180},{"id":220,"depth":486,"text":221},{"id":309,"depth":486,"text":310},{"id":324,"depth":486,"text":325},{"id":346,"depth":486,"text":347},{"id":375,"depth":486,"text":376},{"id":443,"depth":486,"text":444},"md",{},{"description":499,"title":61},"To show a Reader Instance on your website, you give your web team a short piece of code, the embed code. This chapter explains how to get it and what to give…","HQA10WLgy94mticXKaDf3wDPCOA4j6XYjkcY8thHcCE",[502,503],{"title":57,"path":58,"stem":59,"description":484,"children":-1},{"title":65,"path":66,"stem":67,"description":484,"children":-1},1792515139025]