API概述
  • PDF

API概述

  • PDF

可在Classic/VPC环境下使用。

为了有效使用NAVER Cloud Platform提供的服务和解决方案,我们提供API(Application Program Interface,应用程序接口)和SDK(Software Development Kit)。 可根据操作输入、添加、修改、删除和查询参数值,也可用于自动化服务和运行工具。 通常使用以XML、JSON格式响应的API URL形式,大致可分为默认API、兼容API和关联API。

NAVER Cloud Platform提供的三种API的描述如下。

  • 默认API:可使用NAVER Cloud Platform部分服务的NAVER Cloud Platform API(Ncloud API)。 指除了兼容API和关联API的所有API
  • 兼容API:与其他公司API兼容的NAVER Cloud Platform的API。 包含和AWS S3兼容的Object Storage API、和OpenStack Swift兼容的Archive Storage API
  • 关联API:可通过简化形式的调用轻松使用NAVER人工智能服务和应用程序服务的API。 包含CLOVA、Papago、Maps API等

API指南说明

为方便用户有效使用NAVER Cloud Platform的多种API,API指南中包含以下主题。 用户可通过各个主题了解到以下内容。

  • API概述:API指南和通用信息、API分类调用和认证方法、请求和响应数据类型信息的说明
    • API概述:API指南和NAVER Cloud Platform API、Object Storage API、Archive Storage API、NAVER关联API介绍以及便于使用的相关资源、FAQ说明
    • API调用及认证:各类API调用和认证方法、确认支持信息
      • 默认API:调用和认证方法说明、确认支持API和SDK信息、下载SDK
      • 兼容API:调用和认证方法说明、确认支持API信息
      • 关联API:调用和认证方法说明、确认支持API信息
    • API数据类型:可在不同平台使用的API请求和响应数据类型信息
      • VPC:在VPC环境下通用的API数据类型信息
      • Classic:在Classic环境下通用的API数据类型信息
  • Platform:NAVER Cloud Platform的服务收费(Billing)相关API参考资料、区域信息相关API参考资料介绍和使用方法说明
  • Compute:Compute中各项服务的API参考资料介绍和使用方法说明
  • Containers:Containers中各项服务的API参考资料介绍和使用方法说明
  • Storage::Storage中各项服务的API参考资料介绍和使用方法说明
  • Networking:Networking中各项服务的API参考资料介绍和使用方法说明
  • Database:Database中各项服的务API参考资料介绍和使用方法说明
  • Security:Security中各项服务的API参考资料介绍和使用方法说明
  • AI Service:AI Service中各项服务的API参考资料介绍和使用方法说明
  • Application Service:Application Service中各项服务的API参考资料介绍和使用方法说明
  • AI·NAVER API:AI·NAVER中各项服务的API参考资料介绍和使用方法说明
  • Big Data & Analytics:Big Data & Analytics中各项服务的API参考资料介绍和使用方法说明
  • Blockchain:Blockchain中各项服务API的参考资料介绍和使用方法说明
  • Business Applications:Business Applications中各项服务的API参考资料介绍和使用方法说明
  • Content Delivery:Content Delivery中各项服务的API参考资料介绍和使用方法说明
  • Developer Tools:Developer Tools中各项服务的API参考资料介绍和使用方法说明
  • Gaming:Gaming中各项服务的API参考资料介绍和使用方法说明
  • Internet of Things:Internet of Things中各项服务的API参考资料介绍和使用方法说明
  • Management & Governance:Management & Governance中各项服务的API参考资料介绍和使用方法说明
  • Media:Media中各项服务的API参考资料介绍和使用方法说明
  • Migration:Migration中各项服务的API参考资料介绍和使用方法说明

API指南相关资源

除了指南以外,NAVER Cloud Platform还提供多种相关资源以帮助用户理解API。 API相关资源如下。

  • 使用NAVER Cloud Platform API:NAVER Cloud Platform的Ncloud API介绍和结构以及使用方法说明、演示培训视频
  • 挖掘AI/Application服务:NAVER关联API介绍和结构以及使用方法说明、演示培训视频
  • 通过API Gateway开发API和执行商业逻辑:稳定调用API、管理流量和提供监控的API Gateway使用方法说明
  • API Gateway使用指南:可创建RESTful API进行维护管理、控制使用量、监控的NAVER Cloud Platform的API Gateway使用方法说明
  • API Workflow使用指南:可结合NAVER Cloud Platform的的API或基于HTTP的API快速构建新Microservice的NAVER Cloud Platform的API Workflow使用方法说明
  • Application使用指南:介绍如何在控制台中注册应用程序以发放使用NAVER Cloud Platform的API时所需的认证密钥,以及所提供的功能
  • CLI指南:NAVER Cloud Platform中各项服务的CLI指南
  • 常见问题:CLI用户经常提出的问题
  • 咨询:相关问题无法通过CLI指南解决时可直接咨询

首先请查看常见问题。

在阅读API指南之前,可先尝试通过常见问题快速解答疑问。 如果未能在下方常见问题中找到答案,请通过API指南查阅相关内容。

Q. 如何使用API?
A. 请确认已创建认证密钥的Access key和Secret key,然后将其添加到调用API时所用的报头值中使用。 详细内容请参考API指南。

Q. 如何确认已创建API的认证密钥?
A. 登录NAVER Cloud Platform门户网站后,可在我的页面菜单的账户管理 > 认证密钥管理中查看API认证密钥。 认证密钥管理的使用方法请参考门户网站和控制台使用指南

Q. 如何确定使用特定API数据类型的相关操作?
A. 请在API指南提供的搜索框中输入相关操作并确认搜索结果。

Q. 调用其他用户的API时也会收费吗?
A. 该情况下,会向注册API的用户而非调用API的用户收费。

Q. NAVER Cloud Platform门户网站上查不到AI·NAVER API服务类别。
A. 为了帮助用户更好地理解相关内容,NAVER Cloud Platform仅根据服务特性将NAVER的人工智能服务、应用程序服务分为AI Services和Application Services两个类别。 而在控制台中,则分为AI Services、Application Services和AI·NAVER API三个类别,以方便用户使用。

Q: 请求Open API时出现错误的原因是什么?
A. 原因可能是API Gateway认证错误或相应服务错误。 若为API Gateway认证错误,请参考API Gateway的API指南来确认创建签名、请求报头和同步服务器时间的设置是否无误。 如果不是API Gateway认证错误,请参考相应服务的API指南。 如果在排除以上原因后仍然出现Open API错误,请依次点击NAVER Cloud Platform门户网站的客户支持 > 支持中心 > 咨询菜单进行咨询。


本文对您有帮助吗?

What's Next