Instructions/Info

See Embed Web Service (API) for what Embed does and how to use it.

These instructions describe how to setup and debug Embed.

How to run it

You should be familiar with Embed Web Service (API) before using this program and these instructions.

There are three ways to use this screen:
  • to generate the HTML code for a Requestor web page
  • to debug a Requestor web page
  • to debug a Response web page
  • When used in production this service runs behind the scenes and never show the user anything.

    Development and Testing

    Generate Requestor HTML Code

    To generate HTML, use the form below to specify the CheckTLS test you want to embed in your web site, the specifics for what and how to run the test, the results you want back from the test, and the URL of a page on your site that will display the resuls.

    When run interactively you have four Input Fields:

    CheckTLS URL
    The CHECKTLS_URL field from the form: the URL of our test you want to run for the user. See Embed Web Service (API) for valid choices.
    ARGS
    The "a_" fields from the form. Enter one "a_" field per line with an equal sign and the value, for example:
    a_EMAIL=test@checktls.com
    a_LEVEL=-2
    XML Nodes
    The XF field from the form: the XML nodes whose data you want to extract from the test output. Separate multiple fields with a colon (":"). As per the example here, these are exact XML node names (spelling and capitalization are important).
    Return URL
    The RETURN_URL field from the form: the URL of your Response page, which is how we direct the user back to you.

    Use the Show Source button to generate the HTML code that executes the Embed call with the parameters given. The code appears at the bottom of this page below the Input Fields, which keep their values so you can tune them.

    Requestor Testing

    To test your Requestor page, change the ACTION on the <button> line in the HTML code on your Requestor page from "CheckTLS" to "DEBUG". This will run Embed interactively, instead of behind the scenes, showing the fields and values we received from your Requestor page (i.e. the Input Fields below will be filled in with your data).

    If this page does not appear after changing "CheckTLS" to "DEBUG", you probably have a syntax error in your Requestor HTML code. Try using our Requestor HTML code from Embed Web Service (API) and change "CheckTLS" to "DEBUG". Once that works, make one change at a time and test it until your version works.

    Response Testing

    To test your Response page, run Embed interactively from our website. The easiest way to do this is to use the DEBUG option described above under Requestor Testing. That will load the four Input Fields below with your data. Or you can enter the four Input Fields directly below as described above under Generate Requestor HTML Code.

    Use the Show Redirect button to see the http redirect that would be used to load your Response web page. You can coopy/paste this into a browser address bar to verify it loads your Response web page correctly.

    Use the Return Result button to call the listed CheckTLS URL with the listed ARGS, extract the listed XML Nodes, and open your Response (Return URL) web page in a new window. The new window is exactly what users will get from your HTML Code.

    Your input parameters remain on the original screen to make it easy to try different things.

    Input Fields
    Embed parameter entry