What is my API key? And how to use it?
On your account page, you’ll find a long string of characters called an “API key”. The acronym “API” stands for “Application Programming Interface”. An API is like a password for a program to access your account on your behalf.
Where is my API key?
To see your API key, you must first log in.
Once signed in, visit your account page (link is in the top-right corner of the window), where you will find the long chain of characters, which is your key.
What is it for?
Your API key allows programs and websites to interact with your qoiob account remotely, without visiting the website. The same way some applications let you access Twitter and Facebook through their API, for example.
How do I use it?
More and more applications are adding qoiob to their services. When one of them asks you for your email address and API key, you can set up their system to use doiop from it. Never share your actual account password.
But remember to only give your API key to well known services and trustable third parties.
How do I get one?
When you sign up for a qoiob account, you are automatically assigned your personal API key. It is then listed on your account page,
Can I share my API key?
No, it’s like a password to your account.
(Unlike your API key, your real account password should NEVER be shared with anyone.)
How to call my API key from an external service?
We tried to keep our API as simple as possible for users. For example, it’s very easy to set up Tweetdeck to automatically use qoiob as your default shortener. Every information needed is contained in one straight-forward URL.
Whenever a web service or app asks you for a “URL Shortening Endpoint”, you can simply enter the following string, after you replaced “xxx” by your qoiob login email address, “zzz” by your qoiob API key, and “yyy” by the “endpoint” given to you by that service to insert the long URL (for example, “%@” or “%URL%”). Variables are separated by ||
http://qoiob.com/api/shorten/?theKitchenSink=login::xxx||apiKey::zzz||format::txt||longUrl::yyy
or
http://cauzes.com/api/shorten/?theKitchenSink=login::xxx||apiKey::zzz||format::txt||longUrl::yyy
(Note: there should be no space after the ? or anywhere else in the string!)
The simple version above just returns text. Some services require other outputs, usually JSON or XML. If so, you can use the following endpoints:
http://qoiob.com/api/shorten/?theKitchenSink=login::xxx||apiKey::zzz||format::json||longUrl::yyy
http://qoiob.com/api/shorten/?theKitchenSink=login::xxx||apiKey::zzz||format::xml||longUrl::yyy
Can I choose which domain will be used when new shortcuts are created automatically from the API?
Yes, read this post for more details on how to set the endpoint link.
-
Comments? Questions? Tell us what you think at twitter.com/qoiob_com
