{% extends "base.html" %} {% block content %}

The ShortMe API

ShortMe's API will allow you to access ShortMe's URL shortening capabilities over API.

What you need to get started

  • Access token

Shorten your first link!

  1. Generate an access token.
  2. You'll use the POST method to the /api/shorten endpoint. Append your access token as a header in your request.
    Here's an example: <Authorization: Bearer {token}>

    Example call:
    POST http://shortme.biz/api/shorten?url=http://www.longurl.com

    Example Response: 
    {
        'short_url': shortme.biz/f3Jds,
        'original_url': 'http://www.longurl.com',
        'success':True
    }

Get total URL clicks

You can use ShortMe's API to track the total number of clicks your short URL received

  1. You'll use the GET method to the /api/total_clicks endpoint. Access token is not required.

    Example call:
    GET http://shortme.biz/api/total_clicks?url=shortme.biz/f3Jds

    Example Response: 
    {
        'total': 2,
        'short_url': 'shortme.biz/f3Jds',
        'original_url': 'http://www.longurl.com',
        'success': True 
    }
{# #} {# #} {# #}
{% endblock %}