Difference between revisions of "API"
(jsonp api) |
m (Starting with a cleanup of this page.) |
||
Line 1: | Line 1: | ||
{{articles}} | {{articles}} | ||
{{widget}} | {{widget}} | ||
+ | |||
+ | == What is an API == | ||
+ | |||
+ | An application programming interface (API) is an interface implemented by a software program that enables it to interact with other software. It facilitates interaction between different software programs similar to the way the user interface facilitates interaction between humans and computers. | ||
+ | |||
+ | The Mibbit API allows you to gather information on your widget. You have to have a manager account, and a settings ID for the api to work. Where you see <settingsID> in this document, replace it with your own settings ID. If you cannot find yours, it is located on the widget [[manager]]. | ||
== How many people are using my widget? == | == How many people are using my widget? == | ||
− | |||
If you run a site, and are using the widget, you might want to show elsewhere on your site how many people are using it. Well now you can do that easily. | If you run a site, and are using the widget, you might want to show elsewhere on your site how many people are using it. Well now you can do that easily. |
Revision as of 22:30, 16 November 2010
Wiki Home | FAQ | Features | IRC Commands | IRC Modes | Widget Information | Widget: WebIRC Server Setup | URI Parameters | Wish List | Registration Information | Mibbit Staff |
Home | Quick Start Guide | Live Mibbit Help
Contents
What is an API
An application programming interface (API) is an interface implemented by a software program that enables it to interact with other software. It facilitates interaction between different software programs similar to the way the user interface facilitates interaction between humans and computers.
The Mibbit API allows you to gather information on your widget. You have to have a manager account, and a settings ID for the api to work. Where you see <settingsID> in this document, replace it with your own settings ID. If you cannot find yours, it is located on the widget manager.
How many people are using my widget?
If you run a site, and are using the widget, you might want to show elsewhere on your site how many people are using it. Well now you can do that easily.
The results are updated every 20 minutes, so should give you a reasonable idea of how many mibbitians are chatting but not the exact number. |
First thing you need, is the settingsID. This is in the widget URL you are using (last line in Manager "Prefs").
For example: widget.mibbit.com/?settings=42c110f3cbbaea489c0b0e40a40e6e18&channel=%23chat
The section in bold is the settingsID
Just replace <settingsID> with your particular ID.
Using the API
The link below outputs just the number of mibbitians using your widget. You could use this from PHP,Python,etc and get it to output in the page.
http://api.mibbit.com/<settingsID>
Output:
15
Examples:
api.mibbit.com/42c110f3cbbaea489c0b0e40a40e6e18
ajax api demo
This one outputs a snippet of javascript which will write to the document the current number. So you can include this in your HTML, without any backend changes needed.
http://api.mibbit.com/<settingsID>.js
Usage (on your html-page):
There are <script src="http://api.mibbit.com/42c...e18.js"></script> people chatting
Output:
document.write("15")
Examples:
api.mibbit.com/42c110f3cbbaea489c0b0e40a40e6e18.js (Javascript example)
api-demo (full blown example)
You might prefer to use this link, it’s likely that later on this one will contain more useful info as well.
http://api.mibbit.com/<settingsID>.json
Delivers data as json object to be processed by your javascript (e.g. ajax call):
{mibbitians:15}
Example: api.mibbit.com/42c110f3cbbaea489c0b0e40a40e6e18.json
also availabe, as requested:
http://api.mibbit.com/<settingsID>.jsonp
(details will follow)
Example: http://api.mibbit.com/42c110f3cbbaea489c0b0e40a40e6e18.jsonp?callback=some_function
There are also a couple of graphs updated at
http://api.mibbit.com/graphs/<settingsID>_week_mini.png (thumbnail)
http://api.mibbit.com/graphs/<settingsID>_month_mini.png (thumbnail)
thefollowing graphs may have a wrong scaling (will be fixed as soon as possible)
http://api.mibbit.com/graphs/<settingsID>_month.png
http://api.mibbit.com/graphs/<settingsID>_week.png
Usage:
Last 4 weeks <img src="http://api.mibbit.com/graphs/42c...e18_month_mini.png"> user stats.
Request a Feature
New API features are in the works, and this page will be updated when they are available.
For any feature requests for the new API, ask axod at #help on irc.mibbit.net or add them to the WishList