OAuthomatic::Server - Definition of OAuth server crucial characteristics
version 0.0202
Definition of specific OAuth server - all necessary URLs and some additional information.
Full address of API endpoint used to create OAuth temporary token (initial step of OAuth exchange). Should be documented inside given webservice API docs.
Example: https://bitbucket.org/api/1.0/oauth/request_token
https://bitbucket.org/api/1.0/oauth/request_token
Full address (without params) of web page to which user should be sent to authorize application access. Should be documented inside given webservice API docs.
Example: https://bitbucket.org/api/1.0/oauth/authenticate
https://bitbucket.org/api/1.0/oauth/authenticate
Full address of API endpoint used to create OAuth token (final step of OAuth exchange, executed after successful authorization). Should be documented inside given webservice API docs.
Example: https://bitbucket.org/api/1.0/oauth/access_token
https://bitbucket.org/api/1.0/oauth/access_token
Symbolic name of the server we authorize access to. Usually domain name, sometimes slightly prettified.
Default: hostname extracted from oauth_authorize_page
Example: BitBucket.com.
BitBucket.com
Address of the web page on which client key and secret can be created (note, terminology varies, those may also be called application keys or consumer keys etc). Usually this is labeled "OAuth", "Developer", "Application access", "Access tokens" or similarly, and can be found among security settings or developer settings.
This parameter is optional as sometimes the page may have dynamic address (for example contain user name or id in URL) or not directly addressable (heavily javascripted apps).
Example: https://github.com/settings/applications
https://github.com/settings/applications
Short textual description of that page, used as link text (if site_client_creation_page is known) or instead of link (if not).
Default: [SiteName] application access settings.
[SiteName] application access settings
Any extra help worth presenting to the user while he looks for app keys (for example info how field names map).
OAuth Protocol version supported by the site. Currently either '1.0' or '1.0a' (the latter is default).
OAuth signature method which shold be used. Default: HMAC-SHA1
Marcin Kasperski <Marcin.Kasperski@mekk.waw.pl>
This software is copyright (c) 2015 by Marcin Kasperski.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install OAuthomatic, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OAuthomatic
CPAN shell
perl -MCPAN -e shell install OAuthomatic
For more information on module installation, please visit the detailed CPAN module installation guide.