开始使用Smartsheet API

发表在2016年2月4日

希望使用Smartsheet API构建集成，但不确定从哪里开始?只要遵循这五个步骤，你马上就可以开始跑步了!

  • 步骤1探索开发者资源欧宝体育app官方888

  • 步骤2完成“开发者注册”(可选)

  • 步骤3:生成Access Token

  • 步骤4开始建造吧!

  • 步骤5:获得支持

探索开发者资源欧宝体育app官方888

的智能表开发人员门户是所有开发人员资源的“基地”。欧宝体育app官方888在那里你可以找到API常见问题解答、API文档、关于Smartsheet sdk的信息等等。尽管直接开始构建集成可能很诱人，但提前花时间审查这些资源将在未来获得回报。欧宝体育app官方888

API的常见问题

如果你是一个全新的Smartsheet API，首先查看API的常见问题。这些信息为使用Smartsheet API提供了一些很好的高级上下文。

API文档

一旦你回顾了常见问题解答，就可以进入API文档。不管你是打算创建一个直接访问API的集成，还是一个使用Smartsheet SDK的集成，API文档都包含了很多有用的信息。至少，您应该熟悉以下部分:

内容sdk

内容sdk提供一种通过您选择的语言访问Smartsheet API的方法，而不必从头编写所有代码。没有看到您首选语言的SDK ?给我们写封信这样我们就可以考虑将来的发展了!

**完成“开发者注册”**(可选)

此时，您已经熟悉了Smartsheet Developer Resources，并准备为创建集成奠定基础。欧宝体育app官方888

如果你打算建一个第三方应用程序或者如果你想创建一个沙盒您可以纯粹用于开发和测试目的的智能表帐户(不影响生产智能表帐户中的数据)，您需要完成ob欧宝娱乐app手机下载开发人员登记的过程。

如果上述两种情况都不适用于您——因为您计划使用API来直接在你自己的Smartsheet帐户中访问数据，并且不介意为开发/测试提供单独的沙箱环境——你可以完全跳过注册过程。

生成访问令牌

接下来，通过验证API请求直接访问API，您需要一个API访问令牌，该令牌由您想要访问的Smartsheet帐户拥有*。访问令牌是通过智能表UI生成的:简单登录到您的Smartsheet帐户，然后按照说明操作在这里生成一个令牌。

＊请注意在Smartsheet中拥有系统管理员权限的用户拥有的访问令牌可以启用超出授予“非管理员”令牌的API功能。有关更多信息，请参见管理功能章节。

如果您正在构建一个第三方应用程序来实现OAuth2流(检索可用于代表最终用户访问Smartsheet数据的访问令牌)，那么您就不需要像上面描述的那样手动生成访问令牌。相反，请查阅API文档以获取有关第三方应用开发。

开始构建!

最后，到了有趣的部分——构建集成!这个过程将根据您是否选择使用SDK而有所不同。

使用SDK

使用…SDK作为集成的基础，安装您选择的SDK(按照GitHub上SDK的Readme提供的说明)。然后，利用API文档代码示例:

  • 使用页面右侧的面板，选择您感兴趣的语言选项卡。

  • 检查sdk和示例代码小节，它提供了有关使用SDK连接到Smartsheet和执行API操作的信息。

  • 导航到任意位置API参考节，以查看演示如何使用SDK执行该操作的代码示例。

＊请注意就公开的功能而言，sdk往往落后于实际的API。如果SDK没有公开您需要的API功能，您可以选择从GitHub下载SDK源代码，添加缺失的功能，然后提交一个把请求要求将您的更改合并到GitHub存储库中。

不使用SDK

虽然使用SDK可以简化您的集成项目，但这绝不是强制性的。如果您选择放弃使用SDK，而是从头开始构建自定义集成，请利用API文档作为你的主要资源:

得到支持

在理想的情况下，您的集成会神奇地结合在一起，一路上没有任何挑战。但如果你遇到了其他情况，我们会帮助你的!

遇到无法解决的API问题API故障排除指导，或者有一个问题，没有解决的API文档？将您的问题或问题发布到StackOverflow，我们(以及全球数千名开发人员)随时准备提供帮助。

对API有反馈或者想建议新的API特性?给我们写封信api@smartsheet.com！

最后的话

当第一次使用一个新的API时，不可避免地会有一个学习曲线，但是适当的资源和流程可以让一切变得不同。欧宝体育app官方888我们鼓励您通过充分利用智能表API来加速学习曲线欧宝体育app官方888以及我们在这篇文章中讨论过的指导。与此同时，我们很高兴你能在Smartsheet平台上构建，并期待着收到你的来信如果我们能一路帮忙的话!

评论

评论