Documentation Center

Using the External Preview module API

A description of how to access API documentation and tools to configure your External Preview module.

Access the API help documentation for the External Preview module.

API Help documentation on the available calls can be found here:

https://ish.example.com/ISHCM/Api/help (where ish refers to an example server dedicated to Content Manager)

The last section provides information on External Preview calls such as:

  • GET API/ExternalPreview
  • POST API/ExternalPreview
  • GET Api/ExternalPreview/Resource?logicalId={logicalId}&language={language}

Testing the External Preview module

After configuring the ExternalPreview module to your liking, you can test the configuration for correctness by going to:

https://ish.example.com/ISHCM/Api/ExternalPreview/UserInfo

Example: Using the External Preview test form on what to POST

To familiarize yourself with the API call POST Api/ExternalPreview, you can use the following test form, which provides indications as to the values you need to provide. You can access the External Preview test form here:

https://ish.example.com/ISHCM/Api/ExternalPreview

The values that you should use in this form are:
  • base64Blob: base64 encoded blob with the topic content.
  • host refers to the XSL used to process the content. This is an optional parameter. The default value is ExternalPreview.

External Validate endpoint

External Validate endpoint is part of the External Preview module. You can access the External Validate test form at:

https://ish.example.com/ISHCM/Api/ExternalPreview/Validate

Among its available calls:

  • GET API/ExternalPreview/Validate
  • POST API/ExternalPreview/Validate
The value that you should use in this form are:
  • base64Blob: base64 encoded blob with the topic content.
For successful validation, the topic content
  • needs to have an ish processing instruction.
  • should have UTF-16 encoding.