NAME
WWW::KlickTel::API - A module to use openapi.klicktel.de (Linux only)
VERSION
Version $Revision: 34 $
$Id: API.pm 34 2013-03-14 14:51:02Z sysdef $
SYNOPSIS
This module provides a basic access to the KlickTel API
http://openapi.klicktel.de
NOTE: This POC version supports reverse lookups only.
Get an API key at http://openapi.klicktel.de/login/register
#!/usr/bin/perl
use strict;
use warnings;
use WWW::KlickTel::API;
my $klicktel = WWW::KlickTel::API->new(
api_key => '1234567890123456789013456789012',
);
# -OR-
# create a key file at ~/.klicktel/api_key.txt and run
my $klicktel = WWW::KlickTel::API->new();
METHODS
new
Create the object. All parameter are optional.
my $klicktel = WWW::KlickTel::API->new(
api_key => '01234567890abcdef01234567890abcd',
protocol => 'https', # or 'http' (http is default)
cache_path => '/var/cache/www-klicktel-api/',
uri_invers => 'openapi.klicktel.de/searchapi/invers',
timeout => 10, # ( 1- 600 seconds)
ca_file => '/path/to/ca.file',
client_auth => {
'cert' => '/path/to/ssl.crt',
'key' => '/path/to/ssl.key',
},
proxy_url => 'http://proxy.example.com',
);
test
Run selftest
# run selftest
my $error_count;
$error_count = $klicktel->test();
print 'Module test: ' . ( $error_count ? "FAILED. $error_count error(s)\n" : "OK\n" );
invers
Do reverse lookups of phone numbers
# reverse lookup phone numbers
use Data::Dumper qw(Dumper);
my $result = $klicktel->invers($phone_number);
print Dumper($result);
SUBROUTINES (for internal use only)
_REST_connect
Create and configure REST API connection
_REST_connect();
AUTHOR
Juergen Heine, "< sysdef AT cpan D0T org >"
BUGS
Please report any bugs or feature requests to "bug-www-klicktel-api at
rt.cpan.org", or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-KlickTel-API>. I
will be notified, and then you'll automatically be notified of progress
on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc WWW::KlickTel::API
You can also look for information at:
* RT: CPAN's request tracker (report bugs here)
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=WWW-KlickTel-API>
* AnnoCPAN: Annotated CPAN documentation
<http://annocpan.org/dist/WWW-KlickTel-API>
* CPAN Ratings
<http://cpanratings.perl.org/d/WWW-KlickTel-API>
* Search CPAN
<http://search.cpan.org/dist/WWW-KlickTel-API/>
LICENSE AND COPYRIGHT
Copyright 2013 Juergen Heine ( sysdef AT cpan D0T org ).
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a copy
of the full license at:
<http://www.perlfoundation.org/artistic_license_2_0>
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.