This module provides access to TheTVDB API.

Authentication

This module supports multiple ways to authenticate with TheTVDB API.

If only interested in globally-scoped endpoints (such as fetching series/episode information), Authenticating via TheTVDB.authenticate/1 is all that's required.

Token refreshes are handled automatically by the library.

User Authentication

This module supports multi-user authentication. All functions in TheTVDB.User support an optional username. If the username is omitted, the last authenticated user will be used.

It is recommended that if multiple users have been authenticated, the username should be specified.

TheTVDB.authenticate(api_key, "johnDoe", acct_id)
# => :ok

# Fetch user authentication for johnDoe
TheTVDB.User.info()
# => {:ok, %TheTVDB.User{user_name: "johnDoe", ...}}

TheTVDB.authenticate(api_key, "jamesDean", acct_id)
# => :ok

# Fetch user authentication for jamesDean
TheTVDB.User.info("jamesDean")
# => {:ok, %TheTVDB.User{user_name: "jamesDean", ...}}

Automatic retries

In the event of a service outage, requests will be retried using an exponential backoff strategy. The formula for the delay (in milliseconds) between requests is as follows:

(2 ** num_attempts) * backoff_multiplier

Configuration

The parameters below are able to be configured by the user:

• max_attempts - The maximum number of attempts for a single request (default: 5)
• backoff_multiplier - See "Automatic retries" section above (default: 300)

To modify the default configuration, add the following to your config:

config :thetvdb,
  max_attempts: 10,
  backoff_multiplier: 500