如何获取 Nylas 开放平台 API Key 密钥（分步指南）

Nylas 开放平台提供了强大的功能，帮助开发者快速集成电子邮件、日历、和联系人数据，从而简化工作流程并提升应用效率。通过使用 Nylas API，开发者能够轻松实现实时同步、跨平台支持，以及高级数据操作功能。要获取 Nylas API 密钥，开发者需要在官网注册并创建应用。本文将指导你如何获取 nylas 开放平台 API密钥，并进行初步的可用性测试，同时探讨在使用过程中需要考虑的其他关键因素。

1. 获取 nylas 开放平台 API秘钥步骤

获取 nylas 开放平台 API密钥的过程相对简单，只需几个步骤即可完成：

1.访问官方网站注册/登录：https://dashboard-v3.nylas.com/register

2.登录成功以后会进入到所有应用程序页面，可以在这里看到自己账户所拥有的应用程序。进入对应的应用程序查看密钥信息。

3.进入以后会看到应用的概述页面，从左侧导航栏中找到API密钥，进入API密钥页。

4.如果没有密钥可以点击生成新密钥。

5.输入密钥相关信息，选择到期时间。

6.创建成功以后密钥就会显示出来（注意：密钥只在创建成功的时候显示，请将密钥信息保存）。

2. nylas 开放平台 API密钥可用性测试

在获取API密钥后，进行可用性测试是确保其正常工作的重要步骤。以下是使用curl进行测试的一个案例

以下接口为 nylas 开放平台接口中电子邮件中的 阅读收件箱中的电子邮件接口

输入：

curl --request GET \
--url "https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/messages?limit=5" \
--header 'Accept: application/json, application/gzip' \
--header 'Authorization: Bearer <NYLAS_API_KEY>' \
--header 'Content-Type: application/json'

输出：

你将得到一个JSON格式的响应，其中包含了电子邮件的详细信息，如发件人与收件人信息、邮件中的消息主题、消息的正文内容、消息的附件信息等。

{
"request_id": "d0c951b9-61db-4daa-ab19-cd44afeeabac",
"data": [
    {
        "starred": false,
        "unread": true,
        "folders": [
            "UNREAD",
            "CATEGORY_PERSONAL",
            "INBOX"
        ],
        "grant_id": "1",
        "date": 1706811644,
        "attachments": [
            {
                "id": "1",
                "grant_id": "1",
                "filename": "invite.ics",
                "size": 2504,
                "content_type": "text/calendar; charset=\"UTF-8\"; method=REQUEST"
            },
            {
                "id": "2",
                "grant_id": "1",
                "filename": "invite.ics",
                "size": 2504,
                "content_type": "application/ics; name=\"invite.ics\"",
                "is_inline": false,
                "content_disposition": "attachment; filename=\"invite.ics\""
            }
        ],
        "from": [
            {
                "name": "Nylas DevRel",
                "email": "nylasdev@nylas.com"
            }
        ],
        "id": "1",
        "object": "message",
        "snippet": "Send Email with Nylas APIs",
        "subject": "Learn how to Send Email with Nylas APIs",
        "thread_id": "1",
        "to": [
            {
                "name": "Nyla",
                "email": "nyla@nylas.com"
            }
        ],
        "created_at": 1706811644,
        "body": "Learn how to send emails using the Nylas APIs!"
    }
],
"next_cursor": "123"
}

3. 使用 nylas 开放平台 API搭建应用的其他关键考虑因素

在使用 nylas 开放平台 API搭建应用时，除了获取和测试API密钥外，还需考虑以下因素：

错误处理最佳实践

1.监控无效凭据

您可以使用account.invalid通知触发器或定期查询帐户管理端点来检查帐户的凭据是否无效。一旦用户的帐户被 Nylas 标记为具有无效凭据，您就应该提示用户重新进行身份验证。

如果最终用户最初通过提供用户名和密码来验证其帐户，则仅当密码更改时才需要重新进行验证。

2.监控 API 错误

当请求完成且没有错误时，Nylas API 将返回200 OK响应。其他状态代码（例如4xx或5xx ）表示请求遇到错误。Nylas 在出现错误时返回一致的 JSON 对象，其中包含一个提供有关错误详细信息的message字段。您还可以在Nylas Dashboard中查看有关 API 错误的更多信息。

3.监控速率限制

Nylas 的速率限制功能可防止单个帐户影响平台上其他帐户的可靠性或性能。速率限制很大，因此 Nylas API 可以适应您能想到的任何用例。

当账户达到速率限制时，Nylas API 返回429 HTTP 状态代码；这会阻止完成其他请求。 Nylas 建议您实施指数退避策略，以便帐户在达到速率限制时可以恢复并继续运行。

版本控制

Nylas API 是有版本的。这意味着每当 Nylas 进行向后不兼容的 API 更改时，都会发布新版本。目前支持的API版本，Nylas 目前支持 v2.x 和 v3.x。

在 v2.x 中，新的 Nylas 应用程序在创建时固定为最新版本，并且附加标头可以指定次要版本。
在 v3 中，您可以使用 API URI 字符串（例如/v3/connect ）指定版本。

Nylas 如何计算使用量

Nylas 通过将连接的帐户数量乘以组织计费计划的每个帐户的有效价格来计算您的使用情况。如果每月连接的帐户数量小于或等于您的计费计划中包含的帐户数量，Nylas 会按该计划的每月（“基本”）费率向您收取费用。如果您的组织超出了计费计划中包含的关联帐户数量，Nylas 会按每月常规费率向您收取费用，并为每个额外帐户按比例分配金额。

4. nylas 开放平台 API密钥申请和使用中的常见问题

在申请和使用 nylas 开放平台 API密钥过程中，你可能会遇到以下常见问题：

什么是速率限制？ 服务提供商设置速率限制，限制您在一段时间内可以发出的数据请求数量。如果请求量达到或超过速率限制，提供程序会暂时降低其响应率并返回错误。

什么是元数据？

您可以使用metadata对象将键值对列表添加到日历、事件、消息和草稿对象，以便您可以使用它们存储自定义数据。键和值都可以是任何字符串，每个对象最多可以存储 50 个键值对。键的长度最多可达 40 个字符，值的长度最多可达 500 个字符。

我可以免费使用 Nylas 吗？

是的，Nylas 的免费套餐允许您在沙盒环境中使用最多 5 个帐户来构建、测试和评估 Nylas 平台。

定制计划有何不同？

Nylas 有两个可用的软件包：完整平台和仅限日历。在这些软件包中，我们制定了从基本功能到高级功能的计划，具体取决于您应用程序所需的功能。

5. nylas 开放平台 API进阶指引

在获得 nylas 开放平台 API密钥之后，即可开启API接口对接，本文整理了多篇使用 nylas 开放平台 API的案例，帮助读者更有效地使用 nylas 开放平台 API：

使用日历 API、使用虚拟日历、使用联系人 API、发送电子邮件、使用文件夹和标签

6. 常见问题

问题1：什么是幂简集成平台？

幂简集成是蜜堂有信在2023年打造的一款SAAS产品，建设着国内最全的API平台，为开发者提供全面、高效、易用的API集成管理方案，一站搜索、试用、集成国内和国外API。让用户在AI时代全方位接入互联网，用API连接一切服务和算力，实现价值倍增。

问题2：如何找到 nylas 开放平台 API

幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’ nylas 开放平台 API‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。

问题3： nylas 开放平台 API的替代品有哪些？

市场上存在免费、付费两种替代者

例如

更多竞品可以在 nylas 开放平台找到。

7. 总结

本文总结了获取nylas开放平台API密钥并进行可用性测试的完整流程，展示了通过curl测试“阅读收件箱中的电子邮件”接口的具体操作与结果解析，同时探讨了API应用中的关键考虑因素，如错误处理、版本控制及速率限制，为开发者提供了全面的参考指南，希望能帮助大家更高效地集成邮件功能到应用中，充分发挥API的实际价值。