Adding Readability To The API

Sometimes, articles online are interesting, but the layout of the page, its colors, typography, are all wrong. It’s white on black, and the text is tiny for example.

Readability is a nice system that changes the page and makes it more comfortable to read. It’s also very useful for reading texts on mobile devices. One click and all the format is clean and friendly.

We like Readability, and we know our users like it too. So, we made qoiob support this service, by adding a new parameter to the API, for people who want to send links with Readability already embedded in the short URL.

To enable it, you will need to add a new parameter to the endpoint URL call, which should now be formatted like this:

http://qoiob.com/api/shorten/?theKitchenSink=login::EMAIL||apiKey::KEY||format::txt||readability::1||domain::DOMID||longUrl::LINK

(No space after the “?” or anywhere in the link)

• EMAIL is your email address (used as username for login)
• KEY is your API key (you can find your API key on your account page)
• “format” parameter can output txt, json, or xml
• “readability” can be set to 0 (inactive) or 1 (active)
• DOMID is the ID of the domain you want to use in the shortened link (see list at http://blog.qoiob.com/post/6174059230/api-domain)
• LINK is the final URL destination, usually your endpoint variable

If you don’t want to use it, no need to do anything, and it will simply be ignored.

Note: We didn’t link user databases for cauzes.com and qoiob.com, so you will need to create an account for each if you want to use both. The API works the same on both, just need to change the domain at the beginning of the URL.

-

Tagged: api readability css option link automation url layout colors typography