View Source ExUserCheck (ex_user_check v0.2.1)

Main module for ExUserCheck, providing the base API URL and handling API key retrieval.

This module is responsible for:

  • Defining the root API URL for usercheck.com
  • Retrieving the API key from the application's configuration
  • Raising an error if the API key is missing

Configuration

To use ExUserCheck, you must set your UserCheck API key in your application's configuration:


# config/prod.exs or config/runtime.exs
config :ex_user_check, :api_key, "your_api_key"

Summary

Functions

api_key()

Retrieves the API key from the application configuration

root()

Returns the root API URL for usercheck.com.

Functions

Link to this function

api_key()

View Source 
@spec api_key() :: String.t()

Retrieves the API key from the application configuration

Link to this function

root()

View Source

Returns the root API URL for usercheck.com.

Examples 

iex> ExUserCheck.root()
"https://api.usercheck.com"