API Dokumentaatio - versio 0

Tämä on ensimmäinen julkinen versio rajapinnasta ja kattaa ainoastaan yksinkertaisimmat toiminnallisuudet.

Kaikki toiminnallisuudet elää urlissa http://51.fi/api/v1

/create(/[ json | simple ])

Luo uuden lyhytosoitteen. Palauttaa tuloksen oletuksena JSON-muodossa, mutta laittamalla perään /simple tämä palauttaa vain luodun lyhytosoitteen tokenin.

Ottaa GET tai POST -parametrin url, joka tulee siis olla alkuperäinen lyhennettävä url. Muista urlencode mikäli laitat tämän GET-parametrina.

Esimerkki oletusparametreillä (PHP)

      <?
      $url = 'www.example.com';
      $short = file_get_contents('http://51.fi/api/v1/create?url='.urlencode($url));

      --- palauttaa
      {
        url: 'http://www.example.com',
        tinyurl: 'http://51.fi/rs',
        token: 'rs',
        qr: 'http://51.fi/api/v1/qr/rs'
      }
      

Katso itse: http://51.fi/api/v1/create?url=http%3A%2F%2Fwww.example.com

Esimerkki /simple-parametrilla (PHP)

      <?
      $url = 'www.example.com';
      $short = file_get_contents('http://51.fi/api/v1/create/simple?url='.urlencode($url));

      --- palauttaa
      rs
      

Katso itse: http://51.fi/api/v1/create/simple?url=http%3A%2F%2Fwww.example.com

/qr/token(/size)

Palauttaa QR-koodin kyseiselle lyhytosoitteelle. Valinnaisena arvona size, jolla saa pyydettyä QR-koodin eri kokoisena. Oletuskoko on 200.

Esimerkki

<img src="http://51.fi/api/v1/qr/rs" /> tulostaa

<img src="http://51.fi/api/v1/qr/rs/50" /> tulostaa