Invoking Interface tags with programming languages

JavaScript/jQuery (AJAX requests)

With JavaScript it is possible to perform asynchronous calls to Interface tags. In this way, you can, for example, retrieve contents from the dictionary without reloading the page.

$.get('http://demo.mycashflow.fi/interface/Text?code=TargetContent',
    function(data) {
        $('.result').html(data);
    }
);

Note that tags' attributes are indicated as GET parameters in the address of the called tag. In the example, the {Text} tag is used to retrieve content from the dictionary. The code of the entry to be retrieved is added to the tag as the value of the code attribute.

The request is sent by using the jQuery get() method. The HTML content retrieved by the request can then be written to the desired HTML element.

PHP

The server-side programming language PHP also can be used to retrieve content from MyCashflow store.

To call tags, you can use, for example, the PHP file_get_contents() function:

$new_products = file_get_contents("http://demo.mycashflow.fi/interface/NewProducts?limit=6");
echo $new_products;

In the example, the store's 6 newest products are retrieved by using the {NewProducts} tag.

As the tags return HTML-formatted content, the content of the $new_products variable can be printed on the page as it is.

Creating a JSON object from a product list

By using the between and escape attributes, you can create a JSON object from a product list:

{ProductSet(
      categories: 1|2,
      before: '{',
      between: ',',
      helper: '{{
            "{ProductID}": {
                  "name": "{ProductName(escape: 'json')}",
                  "description": "{ProductFullDesc(escape: 'json')}",
                  "url": "{ProductURL}"
            }
      }}',
      after: '}'
)}

• The categories attribute selects the products to be printed from two product categories.
• The before and after attributes open and close the top-level object.
• The between attribute adds a comma between each product list element.
• The helper attribute defines the format for each product as a JSON object that contains the product's name, description, and URL.
• The escape attribute sets escape characters for content tags, which allow the content to be used as a value in a JSON object.