鍵.png)
使用NestJS和Prisma構(gòu)建REST API:身份驗(yàn)證
2.登錄成功以后會(huì)進(jìn)入到所有應(yīng)用程序頁面,可以在這里看到自己賬戶所擁有的應(yīng)用程序。進(jìn)入對(duì)應(yīng)的應(yīng)用程序查看密鑰信息。
3.進(jìn)入以后會(huì)看到應(yīng)用的概述頁面,從左側(cè)導(dǎo)航欄中找到API密鑰,進(jìn)入API密鑰頁。
4.如果沒有密鑰 可以點(diǎn)擊生成新密鑰。
5.輸入密鑰相關(guān)信息,選擇到期時(shí)間。
6.創(chuàng)建成功以后密鑰就會(huì)顯示出來(注意:密鑰只在創(chuàng)建成功的時(shí)候顯示,請(qǐng)將密鑰信息保存)。
在獲取API密鑰后,進(jìn)行可用性測(cè)試是確保其正常工作的重要步驟。以下是使用curl進(jìn)行測(cè)試的一個(gè)案例
以下接口為 nylas 開放平臺(tái) 接口中電子郵件中的 閱讀收件箱中的電子郵件接口
輸入:
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' ?
輸出:
你將得到一個(gè)JSON格式的響應(yīng),其中包含了電子郵件的詳細(xì)信息,如發(fā)件人與收件人信息、郵件中的消息主題、消息的正文內(nèi)容、消息的附件信息等。
{
"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"
} ?
在使用 nylas 開放平臺(tái) API搭建應(yīng)用時(shí),除了獲取和測(cè)試API密鑰外,還需考慮以下因素:
1.監(jiān)控?zé)o效憑據(jù)
您可以使用account.invalid
通知觸發(fā)器或定期查詢帳戶管理端點(diǎn)來檢查帳戶的憑據(jù)是否無效。一旦用戶的帳戶被 Nylas 標(biāo)記為具有無效憑據(jù),您就應(yīng)該提示用戶重新進(jìn)行身份驗(yàn)證。
如果最終用戶最初通過提供用戶名和密碼來驗(yàn)證其帳戶,則僅當(dāng)密碼更改時(shí)才需要重新進(jìn)行驗(yàn)證。
2.監(jiān)控 API 錯(cuò)誤
當(dāng)請(qǐng)求完成且沒有錯(cuò)誤時(shí),Nylas API 將返回200 OK
響應(yīng)。其他狀態(tài)代碼(例如4xx
或5xx
)表示請(qǐng)求遇到錯(cuò)誤。Nylas 在出現(xiàn)錯(cuò)誤時(shí)返回一致的 JSON 對(duì)象,其中包含一個(gè)提供有關(guān)錯(cuò)誤詳細(xì)信息的message
字段。您還可以在Nylas Dashboard中查看有關(guān) API 錯(cuò)誤的更多信息。
3.監(jiān)控速率限制
Nylas 的速率限制功能可防止單個(gè)帳戶影響平臺(tái)上其他帳戶的可靠性或性能。速率限制很大,因此 Nylas API 可以適應(yīng)您能想到的任何用例。
當(dāng)賬戶達(dá)到速率限制時(shí),Nylas API 返回429
HTTP 狀態(tài)代碼;這會(huì)阻止完成其他請(qǐng)求。 Nylas 建議您實(shí)施指數(shù)退避策略,以便帳戶在達(dá)到速率限制時(shí)可以恢復(fù)并繼續(xù)運(yùn)行。
Nylas API 是有版本的。這意味著每當(dāng) Nylas 進(jìn)行向后不兼容的 API 更改時(shí),都會(huì)發(fā)布新版本。目前支持的API版本,Nylas 目前支持 v2.x 和 v3.x。
/v3/connect
)指定版本。Nylas 通過將連接的帳戶數(shù)量乘以組織計(jì)費(fèi)計(jì)劃的每個(gè)帳戶的有效價(jià)格來計(jì)算您的使用情況。如果每月連接的帳戶數(shù)量小于或等于您的計(jì)費(fèi)計(jì)劃中包含的帳戶數(shù)量,Nylas 會(huì)按該計(jì)劃的每月(“基本”)費(fèi)率向您收取費(fèi)用。如果您的組織超出了計(jì)費(fèi)計(jì)劃中包含的關(guān)聯(lián)帳戶數(shù)量,Nylas 會(huì)按每月常規(guī)費(fèi)率向您收取費(fèi)用,并為每個(gè)額外帳戶按比例分配金額。
在申請(qǐng)和使用 nylas 開放平臺(tái) API密鑰過程中,你可能會(huì)遇到以下常見問題:
什么是速率限制? 服務(wù)提供商設(shè)置速率限制,限制您在一段時(shí)間內(nèi)可以發(fā)出的數(shù)據(jù)請(qǐng)求數(shù)量。如果請(qǐng)求量達(dá)到或超過速率限制,提供程序會(huì)暫時(shí)降低其響應(yīng)率并返回錯(cuò)誤。
什么是元數(shù)據(jù)?
您可以使用metadata
對(duì)象將鍵值對(duì)列表添加到日歷、事件、消息和草稿對(duì)象,以便您可以使用它們存儲(chǔ)自定義數(shù)據(jù)。鍵和值都可以是任何字符串,每個(gè)對(duì)象最多可以存儲(chǔ) 50 個(gè)鍵值對(duì)。鍵的長(zhǎng)度最多可達(dá) 40 個(gè)字符,值的長(zhǎng)度最多可達(dá) 500 個(gè)字符。
我可以免費(fèi)使用 Nylas 嗎?
是的,Nylas 的免費(fèi)套餐允許您在沙盒環(huán)境中使用最多 5 個(gè)帳戶來構(gòu)建、測(cè)試和評(píng)估 Nylas 平臺(tái)。
定制計(jì)劃有何不同?
Nylas 有兩個(gè)可用的軟件包:完整平臺(tái)和僅限日歷。在這些軟件包中,我們制定了從基本功能到高級(jí)功能的計(jì)劃,具體取決于您應(yīng)用程序所需的功能。
在獲得 nylas 開放平臺(tái) API密鑰之后,即可開啟API接口對(duì)接,本文整理了多篇使用 nylas 開放平臺(tái) API的案例,幫助讀者更有效地使用 nylas 開放平臺(tái) API:
使用日歷 API、使用虛擬日歷、使用聯(lián)系人 API、發(fā)送電子郵件、使用文件夾和標(biāo)簽
問題1: 什么是冪簡(jiǎn)集成平臺(tái)?
冪簡(jiǎn)集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品,建設(shè)著國內(nèi)最全的API平臺(tái),為開發(fā)者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內(nèi)和國外API。讓用戶在AI時(shí)代全方位接入互聯(lián)網(wǎng),用API連接一切服務(wù)和算力,實(shí)現(xiàn)價(jià)值倍增。
問題2:如何找到 nylas 開放平臺(tái) API
冪簡(jiǎn)API平臺(tái)可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’ nylas 開放平臺(tái) API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
問題3: nylas 開放平臺(tái) API的替代品有哪些?
市場(chǎng)上存在免費(fèi)、付費(fèi)兩種替代者
例如
更多競(jìng)品可以在 nylas 開放平臺(tái) 找到。
本文總結(jié)了獲取nylas開放平臺(tái)API密鑰并進(jìn)行可用性測(cè)試的完整流程,展示了通過curl測(cè)試“閱讀收件箱中的電子郵件”接口的具體操作與結(jié)果解析,同時(shí)探討了API應(yīng)用中的關(guān)鍵考慮因素,如錯(cuò)誤處理、版本控制及速率限制,為開發(fā)者提供了全面的參考指南,希望能幫助大家更高效地集成郵件功能到應(yīng)用中,充分發(fā)揮API的實(shí)際價(jià)值。
對(duì)比大模型API的內(nèi)容創(chuàng)意新穎性、情感共鳴力、商業(yè)轉(zhuǎn)化潛力
一鍵對(duì)比試用API 限時(shí)免費(fèi)