Authentication

Obtain your credentials

The Email API client requires one credential:

It is available in the Paubox dashboard under API Credentials.

Set your API key once at application startup. All Paubox::Client instances will use it automatically:

require 'paubox'

Paubox.configure do |config|
  config.api_key = ENV['PAUBOX_API_KEY']
end

client = Paubox::Client.new

Override the API key for a specific client instance:

client = Paubox::Client.new(api_key: 'YOUR_API_KEY')

The SDK sets the Authorization header automatically on every request:

Authorization: Token token=YOUR_API_KEY

Paubox::FormsClient requires no credentials:

forms_client = Paubox::FormsClient.new

Never hard-code credentials in source files; always read from environment variables.
The SDK does not log API keys or request bodies.

⌘I