- GVMax (Google Voice)
- Google Voice Growl (Google Voice)
- Prey Fetcher (Twitter)
- Dashboard (Widget)
- Drupal
- irssi
- Gmail (standalone script)
- Gmail (jabber bot; also monitors for online status)
- psyBNC, sBNC (and their tie in with Rooms)
- ZNC
- shroudBNC
- mIRC
- Google Voice
- Skype (Standalone—based on command line script)
- Email (Forwards)
- Wordpress
- Email (GProwl; IMAP idle)
If you need to pass alerts where Growl isn't available, you might be better off using the Perl script than trying to forward it to a Growl machine.
The Perl script is prowl.pl. For more information on how to use it, run perl prowl.pl -help.
You will need to install Crypt::SSLeay, to do so on a Mac run sudo cpan install Crypt::SSLeay. For Linux or BSD, your distribution should have a package for it.
The API is subject to throttling, but it should almost never impact a normal user.
You can find a list of API libraries on the API page.
This describes Prowl's third-party API. Users can find their API keys on the settings page.
Changes
Changes to the API format will be posted to the API thread on the forums.
Limits
IP addresses are limited to 1000 API calls per hour which begins from the start of the first call. If you wish to use more requests, please contact us to discuss being whitelisted.
Methods
SSL is required. All commands are sent to https://prowl.weks.net/publicapi/method (for example, add is https://prowl.weks.net/publicapi/add). Square brackets next to parameters are maximum lengths in bytes. Parameters are required unless otherwise specified.
You should send all arguments in UTF-8 encoding. Some level of conversion is done if you provide other encoding, but it may not succeed.
add (POST)
Add a notification for a particular user.
You must provide either event or description or both.
| apikey [204] | Up to 5 API keys separated by commas. Each API key is a 40-byte hexadecimal string.When using multiple API keys, you will only get a failure response if allAPI keys are not valid. |
| providerkey [40] Optional | Your provider API key. Only necessary if you have been whitelisted. |
| priority Optional | Default value of 0 if not provided. An integer value ranging [-2, 2] representing:
|
| application [256] | The name of your application or the application generating the event. |
| event [1024] | The name of the event or subject of the notification. |
| description [10000] | A description of the event, generally terse. |
verify (GET)
Verify an API key is valid.
For the sake of adding a notification do not call verify first; it costs you an API call. You should only use verify to confirm an API key is valid in situations like a user entering an API key into your program. If it's not valid while posting the notification, you will get the appropriate error.
| apikey [40] | The user's API key. A 40-byte hexadecimal string. |
| providerkey [40] Optional | Your provider API key. Only necessary if you have been whitelisted. |
Return format
You should always use an XML parser. While the structure itself won't change, the format or attributes might in a way that breaks direct string parsing.
Errors
An error will return the following format, as well as an HTTP status code equal to ERRORCODE.
<?xml version="1.0" encoding="UTF-8"?> <prowl> <error code="ERRORCODE">ERRORMESSAGE</error> </prowl>
ERRORCODE can be one of the following:400Bad request, the parameters you provided did not validate, seeERRORMESSAGE.401Not authorized, the API key given is not valid, and does not correspond to a user.405Method not allowed, you attempted to use a non-SSL connection to Prowl.406Not acceptable, your IP address has exceeded the API limit.500Internal server error, something failed to execute properly on the Prowl side.
Success
A success will return the following format, as well as the HTTP status code 200.
<?xml version="1.0" encoding="UTF-8"?> <prowl> <success code="200" remaining="REMAINING" resetdate="UNIX_TIMESTAMP" /> </prowl>
REMAINING is the number of API calls you have left until UNIX_TIMESTAMP (UTC).Libraries
There are different libraries and scripts available which use the API in an array of languages.
- Perl
- WebService::Prowl by Masayoshi Sekimura (Module)
- prowl.pl (Official; Command line)
- PHP
- ProwlPHP by Fenric (Library)
- Python
- prowlpy by Jacob Burch (Modular)
- Ruby
- Java
- jProwlAPI by Christian Ternes
- Lasso
- SHp_prowl by Lieven Gekiere
- .NET
- Prowl.NET by Casey Watson
Web Services
These are web services which will send notifications through Prowl. They do not require running on your own server(s).
- GVMax (Google Voice)
- Google Voice Growl (Google Voice)
- Prey Fetcher (Twitter)
Plugins
These are plugins which you can use to add Prowl notifications to other applications. You can see a bunch of other hacks and scripts on the Prowl forums.
- Dashboard (Widget)
- Drupal
- irssi
- Gmail (standalone script)
- Gmail (jabber bot; also monitors for online status)
- psyBNC, sBNC (and their tie in with Rooms)
- ZNC
- shroudBNC
- mIRC
- Google Voice
- Skype (Standalone—based on command line script)
- Email (Forwards)
- Wordpress
- Email (GProwl; IMAP idle)
1 комментарий:
Подскажите, может сталкивались с такой проблемой, скачал у вас prowl.ipa, установил, зарегался на сайте, но уведомленния приходять только когда захожу в програму на айфоне а пуш не работает =( хоча в других приложениях пуш работает нормально (iphone OS 3.0 jaibreak)
Отправить комментарий