所有文章 > 学习各类API > 如何获取APILayer API密钥(分步指南)
如何获取APILayer API密钥(分步指南)

如何获取APILayer API密钥(分步指南)

在现代应用开发中,访问多功能API工具是提升服务能力的重要一步。APILayer API 提供了强大的数据接口,涵盖验证、汇率、天气数据等多种领域,为开发者带来便捷高效的解决方案。通过使用该 API,开发者可以轻松集成全球化的数据资源,为用户提供可靠的信息服务。本文将指导您如何获取 APILayer API 密钥,并介绍密钥的使用方法以及在开发过程中需要关注的重要注意事项。

1. 获取APILayer API秘钥步骤

获取APILayer API密钥的过程相对简单,只需几个步骤即可完成:

1.访问官方网站注册/登录:https://apilayer.com/

2.API市场:API市场非常丰富,拥有各类的API接口,选择您需要的API进行订阅。

3.订阅:这里为了方便展示,示例使用的的API是 “号码验证API”。(相关定价根据您的需求进行选择)

4.查看API密钥:订阅以后API密钥就会在右侧“您的计划中显示”。

2. APILayer API密钥可用性测试

在获取API密钥后,进行可用性测试是确保其正常工作的重要步骤。以下是使用CURL进行测试的一个案例(以下请求 请求的API是API市场中的 号码验证API):

输入:

curl --request GET \
--url 'https://api.apilayer.com/number_verification/validate?number=14158586273' \
--header 'apikey: 你的API KEY'

输出:

你将得到一个JSON格式的响应,其中包含了电话的详细信息,如运营商、国家代码、号码类型、位置时间等。

示例输出:

{
"carrier": "AT&T Mobility LLC",
"country_code": "US",
"country_name": "United States of America",
"country_prefix": "+1",
"international_format": "+14158586273",
"line_type": "mobile",
"local_format": "4158586273",
"location": "Novato",
"number": "14158586273",
"valid": true
}

3. 使用APILayer API搭建应用的其他关键考虑因素

在使用APILayer API搭建应用时,除了获取和测试API密钥外,还需考虑以下因素:

验证

号码验证 API 使用 API 密钥来验证请求。您可以在“帐户”页面中查看和管理您的 API 密钥。

您的 API 密钥具有许多权限,因此请务必保证它们的安全!请勿在可公开访问的区域(例如 GitHub、客户端代码等)共享您的秘密 API 密钥。

对 API 发出的所有请求都必须包含名为“apikey”的自定义 HTTP 标头。每种编程语言的实现都不同。以下是一些示例。

所有 API 请求都必须通过 HTTPS 发出。通过纯 HTTP 进行的调用将会失败。未经身份验证的 API 请求也会失败。

请求参数

number(可选)

您想要验证的电话号码。例如:14158586273

速率限制

每个订阅都有自己的速率限制。当您成为会员时,您首先要选择适合您的使用需求的速率限制。不用担心;您可以随时升级或降级您的计划。因此,在您开始使用“免费”或“PRO计划”选项并开始使用 API 后,我们可以为您提供升级计划。

当达到速率限制(每日和每月)时,服务将停止响应,并为每个请求返回 HTTP 429 响应状态代码(请求过多),并包含以下 JSON 字符串正文文本。

{
  "message":"You have exceeded your daily\/monthly API rate limit. Please review and upgrade your subscription plan at https:\/\/apilayer.com\/subscriptions to continue."
}

当您的API使用率达到80%和90%时,我们会向您发送提醒电子邮件,以便您立即采取行动,例如升级您的套餐,以防止您的应用程序使用API被中断。

您还可以通过编程方式自行检查您的速率限制。作为向 APILayer 发出每个请求的结果,以下 4 个字段为您提供 HTTP 标头中的所有必要信息。

x-ratelimit-limit-month:每月请求限制

x-ratelimit-remaining-month:本月剩余的请求限制

x-ratelimit-limit-day:每天的请求限制

x-ratelimit-remaining-day:今天剩余的请求限制

错误处理

APILayer 使用标准 HTTP 响应代码来指示 API 请求的成功或失败。一般来说: 2xx 范围内的代码表示成功。 4xx 范围内的代码表示客户端错误,这意味着所提供的信息失败(例如,缺少参数、未经授权的访问等)。 5xx 范围内的代码表示 APILayer 的服务器出现错误(通常根本不会发生这种情况)。

如果响应代码不是 200,则意味着操作因某种原因失败,您可能需要采取相应的操作。您可以检查响应(JSON 格式)中名为“message”的字段,该字段简要解释了报告的错误。

状态码解释
400 – 错误请求该请求不可接受,通常是由于缺少必需的参数。
401 – 未经授权未提供有效的 API 密钥。
404 – 未找到请求的资源不存在。
429 – 请求太多超出 API 请求限制。有关详细信息,请参阅速率限制部分。
5xx – 服务器错误我们未能处理您的请求。 (您可以随时联系我们)

4. APILayer API密钥申请和使用中的常见问题

在申请和使用 APILayer API密钥过程中,你可能会遇到以下常见问题:

1. 什么是NumVerify (号码验证)?

NumVerify 是一个免费、功能强大的 REST API,根据最新的国际编号计划数据库提供国内和国际电话号码验证。将电话号码传递到简单的请求 URL 结构后,API 将返回一个通用的 JSON 响应集,其中包含验证结果、本地和国际格式的请求号码以及有用的国家/地区、运营商和线路类型信息。我们相信,每家以任何方式使用其客户电话号码的在线企业都应该对其进行验证,以确保顺畅的沟通并减少未送达的消息,这就是为什么我们决定每月免费提供 100 次验证请求 – 无需信用卡。您可以在此处注册免费的 API 访问密钥。

2. numverify API由哪个公司运行?

numverify API 是由 apilayer 构建和维护的产品,apilayer 是一家奥地利技术公司,旨在通过为开发人员、初创公司和大公司提供专用且方便的编程接口,帮助他们实现复杂流程的自动化和外包。我们的目标是提供对我们软件的快速、简单的访问,以加快您的应用程序的开发速度并减轻后端的负担。

3. 电话号码如何验证?

我们的电话号码格式验证系统基于最新的国际编号计划,其中包含国内和国际格式的所有移动和固定电话号码的复杂语法规则、运营商数据、线路类型数据和位置信息,总计全球232个国家。只有这样,我们才能确保 API 返回的每个验证结果具有最高水平的质量、可靠性和准确性。

4.numverify API服务安全吗?

是的。由于我们了解您的 API 请求可能包含敏感数据,因此我们为付费客户提供了通过行业标准 256 位 HTTPS 加密访问 API 以及由 API 提供和处理的所有数据的可能性。有关详细信息,请参阅 API 文档。除了验证之外,我们不会出于任何目的处理或存储电话号码。有关详细信息,请参阅我们的隐私政策。

5. APILayer API进阶指引

在获得APILayer API密钥之后,即可开启API接口对接,本文整理了使用APILayer API的案例,帮助读者更有效地使用APILayer API:

案例

获取支持的区域列表,包括国家/地区名称和拨号代码

请求示例 curl

curl --request GET \
--url 'https://api.apilayer.com/number_verification/countries' \
--header 'apikey: NcLgC8zVPe8DCS5WDGIZhi6XPlVngXOR'

响应示例

{
"AD": {
  "country_name": "Andorra",
  "dialling_code": "+376"
},
"AE": {
  "country_name": "United Arab Emirates",
  "dialling_code": "+971"
},
"AF": {
  "country_name": "Afghanistan",
  "dialling_code": "+93"
},
"AG": {
  "country_name": "Antigua",
  "dialling_code": "+1"
},
"AI": {
  "country_name": "Anguilla",
  "dialling_code": "+1"
}
}

6. 常见问题

问题1: 什么是幂简集成平台?

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

问题2:如何找到APILayer API

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

问题3:APILayer API的替代品有哪些?

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

例如

API云市场接口介绍及对接

Finazon-全球金融数据API市场

APILayer-无忧虑的 API 市场

apised-api

indianapi-印度API市场

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

7. 总结

本文详细讲解了如何注册登录 APILayer 平台并选择合适的 API 市场,从中挑选适合需求的 API(如号码验证 API)进行测试的具体方法。通过示例代码和输出解析,您可以快速掌握 API 的基本用法。同时,我们还分享了速率限制和错误处理的相关信息,帮助您应对使用过程中可能遇到的问题。希望本文能为您在 API 市场的探索和实际开发中提供有益的指导,让您的开发之旅更加高效和便捷。

#你可能也喜欢这些API文章!