README
¶
Areena
Go client for interacting with Yle Areena API. WIP.
Usage
define the following environment variables (get these from http://developer.yle.fi/):
export YLE_APP_ID="YOUR_APP_ID"
export YLE_APP_KEY="YOUR_APP_KEY"
export YLE_SECRET="YOUR_APP_SECRET"
Documentation
¶
Index ¶
- Variables
- func DecryptURL(secret string, encStr string) (url string, err error)
- func Slugify(s string) (res string)
- type Client
- func (c *Client) Do(req *http.Request, v interface{}) (err error)
- func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)
- func (c *Client) Playout(programID string, mediaID string, protocol string) (playout *responses.Playout, err error)
- func (c *Client) Program(programID string) (program *responses.Program, err error)
- func (c *Client) ProgramDetails(programID string) (details *results.ProgramDetails, err error)
- type Config
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrNotFound - resource was not found ErrNotFound = errors.New("Resource not found") ErrMediaIDMissing = errors.New("Failed to find available media id") )
Functions ¶
func DecryptURL ¶
DecryptURL decrypts URL according to http://developer.yle.fi/tutorial-playing-a-program/
Types ¶
type Client ¶
type Client struct {
// Base URL for API requests, should have a trailing slash.
BaseURL *url.URL
// User agent
UserAgent string
// contains filtered or unexported fields
}
Client manages communication with the Yle API.
func (*Client) NewRequest ¶
NewRequest creates an API request. Areena API is GET only.
func (*Client) Playout ¶
func (c *Client) Playout(programID string, mediaID string, protocol string) (playout *responses.Playout, err error)
Playout fetch playout details
func (*Client) ProgramDetails ¶
func (c *Client) ProgramDetails(programID string) (details *results.ProgramDetails, err error)
ProgramDetails fetch & parse program details for given programID
type Config ¶
type Config struct {
YleAppID string `envconfig:"APP_ID" required:"true"`
YleAppKey string `envconfig:"APP_KEY" required:"true"`
YleSecret string `envconfig:"SECRET" required:"true"`
APIBaseURL string `envconfig:"BASE_URL" default:"https://external.api.yle.fi/v1/"`
Debug bool `envconfig:"DEBUG" default:"false"`
HTTPClient *http.Client
}
Config - client settings
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.