生物信息学分析

NCBI API key 指南

2020-10-09  本文已影响0人  JeremyL

如果经常使用NCBI,就知道E-utilities API。2018年5月1日以后,NCBI将限制E-utilities访问,但是获取一个API 密钥之后就可以不受限制。

获得一个API密钥是很简单的,它将允许用户更快地访问NCBI数据。如没有API密钥,E-utilities仍然可以工作,但可能会被限制在比有API密钥的请求更少的访问数量。

#API key 是什么?

每一个NCBI注册用户可以获取一个独有的API key,作为访问NCBI时的身份鉴定;使用API key可以更快地访问NCBI更多地数据。

#API key 具体优点

持续性:E-utilities API 是一项免费持续向公众开放的服务。
安全性:使用API key可以保护NCBI免受恶意网络攻击和资源浪费。
性能:API key向NCBI后台反馈用户如何使用E-utilities,方便NCBI 服务持续优化。

#什么时候需要API key

当不使用API key时,NCBI数据库的检索工具(E-utils)允许用户最多每秒提交3次请求,否则返回error;反之,可以达到10次每秒。

#怎么获取API key

首先需要一个NCBI账号
登陆账号,进入setting页面找到API Key Management即可创建一个API Key.

API key

例子:
示例:假设您获取一个密钥“ABCD123”。下面是一个简单的EInfo请求:

https://www.ncbi.nlm.nih.gov/entrez/eutils/einfo.fcgi?db=pubmed&api_key=ABCD123

#获取了密钥,还存在访问限制吗?

是的。默认情况下,密钥访问将限制为10个请求/秒的所有活动从该密钥。如果NCBI以更高的频率接收包含相同密钥的请求,那么使用该密钥的所有请求都将收到一条错误消息。如果需要更高的访问率,请联系 contact us

请求限制适用于使用给定密钥的所有请求,而与IP地址无关。因此,如果多台计算机使用相同的键,那么如果它们活动的总和导致请求速率超过每秒10,那么所有这些计算机都将接收到错误。

#可以获取多少个密钥

每个NCBI帐户使用一个API密钥。如果出于任何原因希望将现有密钥替换为新密钥,可以在NCBI帐户设置页面上执行此操作。

#编写了访问的软件,如果软件被其他人使用,用户需要密钥吗?

可以,但前提是软件允许他们每秒发布超过三个请求。对于这种情况,建议允许用户在软件中输入他们自己的API密钥作为设置。

#参考:

New API Keys for the E-utilities
E-utilities Quick Start

上一篇下一篇

猜你喜欢

热点阅读