Download the PHP package katmore/shrturl without Composer

shrturl

a URL shortener webservice

Shrturl is a RESTful web service that behaves similar to enterprise level URL shortening services (such as bit.ly).

• Latest Version:

  • http://github.com/katmore/shrturl
• Documentation
  • http://github.com/katmore/shrturl/wiki

Terminology

• code or short code: the unique portion (token) contained in a short URL that serves as reference to full URL. The typically jibberish looking sequence of alpha numeric characters used in most URL shorteners.
• short url: the full URL that includes the short code (ie: http://example.com/shrt.php?code=abc)
• target url: the full URL that needs to be changed into a short URL

Installation

1. extract/copy the shrturl project somewhere

2. create autoloader and resolve dependencies using Composer...

3. run the db-install.php script...

4. copy app/config/shrturl/mysql-sample.ini to mysql.ini and edit...

5. populate the database with initial set of randomly generated short codes...

Webservice Usage

• Redirect to target URL:

  https://example.com/shrt.php?code=abc

  (where 'abc' is the code returned by "Shorten URL" request)

• Display short URL, Create if it does not exist

  • POST REQUEST METHOD https://example.com/shrt.php?target=http://my_really_long_uri
    • adding a query var named 'POST' to the query string to will also invoke 'POST' (if using GET REQUEST METHOD)

      https://example.com/shrt.php?POST&target=http://my_really_long_uri

  • add a query var and value for 'url_base' if you want to display a short url with a base

    URL other than what is configured in the 'default' section of shrt-config. A value for 'url_base' should correspond with a config var in shrt-config.php

  • POST REQUEST METHOD

    https://example.com/shrt.php?target=http://my_really_long_uri&url_base=reallyshort

    • would display/create: http://rlysh.rt/abc
    • see example in shrt-config-example.php [https://github.com/katmore/shrturl/blob/master/shrt-config-example.php]

• Change Target URL

  • POST REQUEST METHOD

    https://example.com/shrt.php?changeTarget=http://a_different_really_long_uri&code=abc

  • adding a query var named 'POST' to the query string to will also invoke 'POST' (if using GET REQUEST METHOD)

• Shorten Multiple URLs

  • POST REQUEST METHOD

    https://example.com/shrt.php?request={JSON_document}

  • where 'target' is a valid JSON document with the following structure:

  • adding a query var named 'POST' to the query string to will also invoke 'POST' (if using GET REQUEST METHOD)

Webservice Deployment Suggestions

• use 2 different FQDNs (fully qualified domain names) for this service

  • FQDN #1 for 'end use' the short code, such as:

    http://rlysh.rt

  • FQDN #2 for API calls to short code service, such as:

    https://shrturl.example.com

• for example:

  1. on the 'end use FQDN' (#1)

     1. install/configure project as described in installation section of this document
     2. configure a url_base in addition to the 'default'

        see url_base section in shrt-config-example.php

        • contains example of .htaccess or equivelent configuration for web server
        • http://rlysh.rt/abc will work now
        • where 'abc' is the short code provided by previous call to short API

  2. on the 'API FQDN' (#2) use as described in usage section

     in API requests to obtain a short code ensure that: provide a url_base parameter in query that corresponds to the 'end use' that is set in your shrt-config-example.php

Legal

Copyright

Flat webapp - https://github.com/katmore/flat-webapp

Copyright (c) 2012-2017 Doug Bird. All Rights Reserved.

License

"shrturl" is copyrighted free software.

You can redistribute it and/or modify it under either the terms and conditions of the "The MIT License (MIT)"; or the terms and conditions of the "GPL v3 License".