发出第一个API请求

了解如何开始使用特使API。

完成时间:10分钟

本教程描述了开始使用特使API的基本步骤。本教程将向您展示如何获取访问令牌,然后调用locations API来获取关于特使位置的详细信息。

创建一个开发人员帐户

报名以便开发人员帐户访问集成构建器创建和管理应用程序,供公司内部私下使用或与他人公开分享。

创建一个API用户

在调用API之前,您需要设置一个API用户帐户。出于演示目的,本指南将向您展示如何使用特使API进行身份验证OAuth2密码授予类型。

❗️

密码授予类型应该只用于你为你的公司创建的私人应用程序。如果您正在为其他人构建应用程序,则需要按照下面的步骤进行身份验证指南

  1. 在您的雇员目录
  2. 分配用户全球管理的角色。
  3. 确保设置在访客亭上显示员工为主持人是禁用的

获取客户端id和秘密

您将需要一个客户端id和secret来检索一个访问令牌,以便使用API进行身份验证。要生成客户端id和secret,需要使用integration Builder创建集成。

  1. 指示板并点击集成>集成构建器
  2. 点击连接帐户
  3. 点击创建新的
  4. 为您的集成提供一个名称
  5. API范围添加范围locations.read
  6. 检查集成准备好显示了吗?
  7. 点击保存集成

以下是集成配置设置的样子

  1. 所有集成选项卡查找您刚刚创建的集成并进行选择配置
  2. 复制客户端id和客户端秘密特使API凭证部分。

获取访问令牌

接下来,您需要交换客户机id、secret、用户名和密码,以获得一个访问令牌,该令牌可用于验证API请求。

调用令牌APIoauth2 /令牌并使用下面的curl示例格式化您的请求。

curl——location——request POST 'https://api.www.vmcaa.com/oauth2/token' \——header "Authorization: Basic $(echo -n {ENVOY_CLIENT_ID}:{ENVOY_CLIENT_SECRET} | base64)" \——form "username={USER_EMAIL}" \——form "password={password}" \——form "scope=token.refresh,location . list . list . list . list . list . list . list . list . list . list。读取" \——form "grant_type=password"
{"token_type": "支座","access_token": "{YOUR_ACCESS_TOKEN}", "expires_in": 86400, "refresh_token": "{YOUR_REFRESH_TOKEN}", "refresh_token_expires_in": 2592000, "state": null, "company_id": "10000"}

记住在授权头中对客户端ID和secret进行base64编码。

的名字 描述
授权 使用客户端ID和secret作为base64编码的用户名和密码的基本身份验证头。
client_id 应用程序的客户端ID。
client_secret 客户端为您的应用程序保密。
grant_type 设置为密码
范围 设置为token.refresh, locations.read.这将允许我们检索位置信息。如果希望获取其他类型的数据,则需要包含适当的作用域。了解更多关于作用域。

发出API请求

要获取帐户的位置列表,请在授权头中使用在上一步中返回的访问令牌,并调用位置的API/ api / v3 /位置

curl——location——request GET 'https://app.www.vmcaa.com/a/visitors/api/v3/locations'——header '接受:application/vnd。api+json'——header '授权:承载{YOUR_ACCESS_TOKEN}'
{"data": [{"id": "94082", "type": "locations", "links": {"self": "https://app.www.vmcaa.com/api/v3/locations/94082"}, "attributes": {"address": "410 Townsend St 4楼,San Francisco, CA 94107, USA", "address-line- 1 ": "410 Townsend St", "address-line- 2": "4楼","auto-sign-out-at-midnight":false, "blacklist-filters-csv-upload-status": null, "city": "San Francisco", "company-name-override": "Envoy", "deliveries-onboarding-complete": false, "disabled": false, "capacity-limit": 5}}

如果您希望通过API访问其他资源,请记住在集成生成器的作用域部分和范围/token端点中的值。


下一个步骤
这个页面对你有帮助吗?
Baidu