OAuthomatic::Server

- NAME
- VERSION
- DESCRIPTION
- PARAMETERS
  - oauth_temporary_url
  - oauth_authorize_page
  - oauth_token_url
  - site_name
  - site_client_creation_page
  - site_client_creation_desc
  - site_client_creation_help
- ATTRIBUTES
  - protocol_version
  - signature_method
- AUTHOR
- COPYRIGHT AND LICENSE

# NAME

OAuthomatic::Server - Definition of OAuth server crucial characteristics

# VERSION

version 0.02

# DESCRIPTION

Definition of specific OAuth server - all necessary URLs and some additional information.

# PARAMETERS

## oauth_temporary_url

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`

## oauth_authorize_page

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`

## oauth_token_url

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`

## site_name

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`.

## site_client_creation_page

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`

## site_client_creation_desc

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`.

## site_client_creation_help

Any extra help worth presenting to the user while he looks for app keys (for example info how field names map).

# ATTRIBUTES

## protocol_version

OAuth Protocol version supported by the site. Currently either '1.0' or '1.0a' (the latter is default).

## signature_method

OAuth signature method which shold be used. Default: HMAC-SHA1

# AUTHOR

Marcin Kasperski <Marcin.Kasperski@mekk.waw.pl>

# COPYRIGHT AND LICENSE

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.