Publishers & Writers

Introduction

Readability provides a simple URL shortening service. If you send us a URL to an article, we'll send back an rdd.me URL. The resulting URL is a shortened link to the Readability view of the article you submitted. This allows you to easily share your favorite articles with others.

Go to http://rdd.me to start sharing today.

API

The Readability Shortener API allows developers to interact with the URL Shortener feature set of Readability. This means passing a URL of an article, and getting back a short URL to the Readability version of that Article.

Quick Start

Here's how to create a new shortened URL:

Request

POST /api/shortener/v1/urls
Content-Type: application/x-www-form-urlencoded

url=http://blog.arc90.com/2010/11/30/silence-is-golden/
        

Response

HTTP/1.0 200 OK

{
    "meta": {
        "url": "/api/shortener/v1/urls/tg8if9uj",
        "rdd_url": "http://rdd.me/tg8if9uj",
        "id": "tg8if9uj"
    },
    "messages": [
        "URL shortened."
    ],
    "success": true
}

        

Authentication

No Authentication is required.

Data Formats

All requests are provided as JSON.

Resources, Representations & Errors

• Resources
  • http://www.readability.com/api/shortener/v1/
  • http://www.readability.com/api/shortener/v1/urls
    • http://www.readability.com/api/shortener/v1/urls/{url_id}
• Representations
  • Example root representation. (application/json)
  • Example Successful URL creation response. (application/json)
  • Example URL representation. (application/json)
• Errors
  • 500 Internal Server Error (application/json)
  • 404 Not Found (application/json)

Resources

Representations

{
    "resources": {
        "urls": {
            "href": "/api/shortener/v1/urls",
            "description": "The URLs endpoint. POST a URL to add it to the shortener"
        }
    }
}
            

{
    "meta": {
        "url": "/api/shortener/v1/urls/tg8if9uj",
        "rdd_url": "http://rdd.me/tg8if9uj",
        "id": "tg8if9uj"
    },
    "messages": [
        "URL shortened."
    ],
    "success": true

{
    "meta": {
        "article": {
            "url": "http://blog.arc90.com/2010/11/30/silence-is-golden/",
            "author": "Tim Meaney",
            "excerpt": "It is a mostly well-known fact, yet nearly...",
            "word_count": 1126,
            "title": "Silence is Golden"
        },
        "rdd_url": "http://rdd.me/tg8if9uj",
        "id": "tg8if9uj",
        "full_url": "http://readability.com/articles/tg8if9uj"
    },
    "messages": [
        "Article found."
    ],
    "success": true
}

Errors