Skip to content

Commit 5015b6a

Browse files
authored
Merge pull request #17 from emailable/readme-access-token-auth
2 parents ce1d69a + 5bc8eb1 commit 5015b6a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,23 @@ Or install it yourself as:
3232

3333
### Authentication
3434

35-
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).
35+
The Emailable API requires either an API key or an access token for
36+
authentication. API keys can be created and managed in the
37+
[Emailable Dashboard](https://app.emailable.com/api).
3638

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

3941
```ruby
40-
Emailable.api_key = 'your_api_key
42+
Emailable.api_key = 'your_api_key'
4143
```
4244

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

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

49-
# set access_token at request_time
51+
# set access_token at request time
5052
Emailable.verify(access_token: 'your_access_token')
5153
```
5254

0 commit comments

Comments
 (0)