Documentation

Introduction

I wouldn't really consider this an API, especially in the format it is at the moment. It's more of a readible page that is formatted in JSON, raw PHP Array or XML that lets you easily get the latest version of each Snow product without having to open up the Snow Update Service, it also means you can easily send a link to an end-user that shows them the current versions of products (such as a technical engineer).

The information in the API currently updates on an hourly basis.

Quick Start

The easiest way to get started is by using one of the example scripts. These are minimal at the moment, however I am accepting submissions for different languages. At the moment, the only examples are in VB.NET, C# and standard PHP.

You can get a full list of available examples from here. The below PHP example is provided as a quick start.


<?php
    $json = file_get_contents('https://ext.laim.scot/snowapi/api/1.0/?format=json');
    $obj = json_decode($json, true);

    foreach ($obj as $i) {
        echo 'Name: ' . $i['Name'] . '<br>';
        echo 'Version: ' . $i['Version'] . '<br>';
        echo 'Release: ' . $i['Date'] . '<br>';
        echo '<hr>';
    }
?>
                                    

Available Output

Formats

There is three API formats at the moment, JSON, XML and standard PHP Array output. Depending on your project, knowledge and just what you want to do in general you can use any of the three available.

As of version 1.0, it defaults to the PHP Array output. Formatting information available below.

Format Key Value Full
Standard N/A N/A /snowapi/api/1.0/
JSON format json /snowapi/api/1.0/?format=json
XML format xml /snowapi/api/1.0/?format=xml