Skip to content

README changes based on changes in add-access-token-auth #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jclusso merged 1 commit into from
May 29, 2025
Merged

README changes based on changes in add-access-token-auth #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,23 @@ Or install it yourself as:

### Authentication

The Emailable API can be authenticated with in a few ways. You will need an API key or an Access Token to authenticate. API keys are available in your [Emailable Dashboard](https://app.emailable.com/api).
The Emailable API requires either an API key or an access token for
authentication. API keys can be created and managed in the
[Emailable Dashboard](https://app.emailable.com/api).

The library can be configured globally with your account's API key
An API key can be set globally for the Emailable client:

```ruby
Emailable.api_key = 'your_api_key
Emailable.api_key = 'your_api_key'
```

Alternatively, you can pass an `api_key` or an `access_token` at request time to any of the endpoint methods.
Or, you can specify an `api_key` or an `access_token` with each request:

```ruby
# set api_key at request time
Emailable.verify(api_key: 'your_api_key')

# set access_token at request_time
# set access_token at request time
Emailable.verify(access_token: 'your_access_token')
```

Expand Down