Skip to content

Commit

Permalink
Merge pull request #49 from mailsac/add_api_key_login
Browse files Browse the repository at this point in the history
Add section for api key login to website
  • Loading branch information
mjmayer committed Oct 12, 2020
2 parents 7f017d6 + b8dbe66 commit 917f592
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 5 deletions.
10 changes: 10 additions & 0 deletions about/faq.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _`REST API`: https://mailsac.com/api
.. _`Unified Inbox`: https://mailsac.com/app
.. _`pricing`: https://mailsac.com/pricing
.. _api_key_login: https://mailsac.com/login-api-key

.. _faq:

Expand Down Expand Up @@ -105,3 +107,11 @@ emails. New accounts have 5 sending credits. Additional credits can be
You can use `POP3 <https://mailsac.com/docs/fetch-messages-with-pop3>`_ to
download messages on a private address or custom domain. Responses can be sent
from non-mailsac accounts you have configured your email client to use.

How can my team members see email in our private domain?
--------------------------------------------------------

For `plans <pricing_>`_ that support multiple API keys. You can
:ref:`create API keys <sec_api_key_management>` for your team members. These
name API keys can be used for API access and
`website authentication <api_key_login_>`_.
58 changes: 53 additions & 5 deletions help/account_management/account_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
.. _`REST API`: https://mailsac.com/api
.. _`API Keys`: https://mailsac.com/api-keys
.. _`API Use`: https://mailsac.com/usage
.. _`API Key Login`: https://mailsac.com/login-api-key

.. _doc_account_management:

Expand Down Expand Up @@ -35,26 +36,73 @@ API Key Management

API keys are used to authenticate to the `REST API`_,
:ref:`Email Capture <doc_email_capture>`, :ref:`SMTP <sec_sendingmail_smtp>`,
and :ref:`POP3 <sec_reading_mail_pop3>`.
:ref:`POP3 <sec_reading_mail_pop3>`, and `API Key Login`_.

API Keys can be created, viewed, and deleted `API Keys`_ section of the
API Keys can be created and deleted in the `API Keys`_ section of the
Dashboard_.

Multiple Named API Keys
^^^^^^^^^^^^^^^^^^^^^^^

For teams, using unique API Keys, can help with access control, monitoring
usage, and ensuring a unique API Key in each environment.
For accounts with individual plans, only one API key is allowed.

For accounts with team plans, multiple API keys may be created, each with a
unique name.

Having multiple API keys enables:
- restricted access control
- usage monitoring
- separate API Keys in each app environment

To create a named API key, go to the `API Keys`_ from the Dashboard_. Enter a
name for the API Key and select *Generate new API key*.
name for the API Key and select *Generate new API key*. API Keys may only be
viewed once and are not retrievable by the system. API Keys should be treated
with the same security considerations as a password..

.. figure:: add_named_key.png
:align: center
:width: 400px

Create new name API key


Enable Website Login Using an API Key
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Website login can be enabled on a named API Key. This setting can be found in
the Dashboard_ under `API Keys`_. The feature is not enabled for individual
plans, such as Basic and Indie.


.. figure:: enable_api_key_login.png
:align: center
:width: 400px

Enable API Key Login

When logged into the website using an API Key, the user session is restricted
from:

- viewing and modifying payment information
- adding or removing API keys
- managing account features
- adding or removing custom domains

Login Using an API Key
^^^^^^^^^^^^^^^^^^^^^^

Use the `API Key Login`_ to sign into Mailsac using an API key.

- **Account ID:** The primary account name used to sign up for Mailsac
- **Key Name:** The name of the API Key
- **API Key:** The value of the API Key

.. figure:: login_using_api_key.png
:align: center
:width: 400px

Login using an API Key

API Usage
---------

Expand Down
Binary file added help/account_management/enable_api_key_login.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/account_management/login_using_api_key.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 917f592

Please sign in to comment.