/
Whitepapers > Websites

Whitepapers > Websites

 

Platform URL

https://[enterprise].cvtr.io/v2/system/whitepapers/website

 

API Endpoints

Retrieves the collection of Website resources/Creates a Website resource:

GET/POST https://{enterprise}.cvtr.io/api/v4/websites

Retrieves/Removes/Replaces a Website resource:

GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/websites/{id}

Epic

https://convertr.atlassian.net/browse/CON-4296

Document status

REVIEWED

Document owner

@Adam Carter

Technical writers

@Adam Carter

Feature Overview

The white papers website section allows users to embed our solution onto an external website by implementing various tags that can be added to their website.

This section of the platform can be accessed by navigating to System > Whitepapers > Websites and is accessible only to admin users.

The following functionalities are available in this section:

  1. Website listing page

  2. Add website

  3. Edit website

  4. Delete website

  5. Copy tags

Listing Page

Add Website

Name

Description

Name

Description

1

Name

Name of the website

2

Domain

The domain you are embedding the tag onto

3

Category URL

The category URL you are embedding the tag onto

4

Landing Page URL

The landing page URL you are embedding the tag onto

5

Rotation

Deafault: Would display white papers based on when the campaign is ending

Newest: shows the most recent white papers uploaded

6

Advertisers

You can filter the white papers on this domain by the white papers associated to a certain advertiser

7

Domain (restrict to Domain)

You can restict the website tag to a specify domain.

Tags

Block

This allows you to embed a content block onto the page this can just be a listing block or a carousel.

The below tag will render all live white paper assets (max 5) assigned to a content block.

<script src="https://demo.cvtr.io/whitepapers/v2/block.js?w=5&locale=1"></script>

To reference a single block the tag can be amended by passing the BLOCK ID. If you wish to reference multiple blocks the tag can be amended by passing the block id with a comma in between eg BLOCK ID, BLOCK ID.

The BLOCK ID can be found within the 'Content Blocks' tab.

To display the content block as a carousel, the parameter 'carousel=true' has to passed within the tag, along with this script (see below).

The below parameters can be applied to the tag to change autoplay, autoplay speed, click speed and adaptive height:

This controls the carousel to be on a continuous loop. default is 1 (true), 0 (false)

This controls the speed of the carousel while on auto play, the default is 3000 (which equates to 3 seconds)

This controls the speed of carousel when you click the next button, default is 300

This controls the adaptive height, default is 1 (true), 0 (false)

To control the number of white papers assets that can be viewed within the content block, the parameter limit=NUMBER_OF_ASSETS can be passed.

*The locale parameter is used to pass different languages via the tag (optional), the ID for this can be found in the Enterprise > Content Languages section.

Category

This allows you to group the white papers by platform categories.

The below tag will render the 'Category URL' tag. This allows the output of the categories setup within the platform.

Search

This allows you to search for a white paper by keyword or advertiser.

The below tag will render the search functionality on your webpage.

To implement the form place the HTML below. Within the form action attribute input your 'Search Results page as this is where your search results will display.

WP Landing

This allows the landing page to be embedded to your website

WP Landin

Advertiser

This allows you to group the white papers by advertisers

WP by Tag

This allows you to group the white papers by key word tags

The below tag will render the 'WP Tag' tag. This allows the output of the specific white papers that have a tag associated with the asset.

To populate the page with specific white papers, without a category or subcategory this can be done by passing the below

To populate the page with specific white papers, with a category this can be done by passing the below

To populate the page with specific white papers, with a category or subcategory this can be done by passing the below

 

Example

https://cvtr.s3.amazonaws.com/wp-demo/index.html

Summary

Functionality

User Story

Functionality

User Story

1

Add Website

A user must add a name, Domain,Category URL,Landing Page URL and set a Rotation

Advertisers and Domain are optional filter

2

Delete Website

A user can delete a website

3

Edit Website

A user can edit a website

4

Copy Tag

A user can copy all tag using the clipboard funtion

5

Custom Tables

A user can add, remove and reset columns for custom table

 User Permissions

Only admin users have access to System > Whitepapers > Websites

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=67588165

 

Related content

Whitepapers > Content Blocks
Whitepapers > Content Blocks
More like this
System Audit
System Audit
Read with this
Whitepaper Library: Hosting of the White paper library
Whitepaper Library: Hosting of the White paper library
More like this
System Categories
System Categories
Read with this
Landing Pages
Landing Pages
More like this
Subject Access Request
Subject Access Request
Read with this