跳到主要内容

Hello World

本文将向您展示如何开始使用Buddy API：获取身份验证令牌并执行API方法。

身份验证​

在使用API之前，您需要进行身份验证。 身份验证基于oAuth机制。为了调用API方法，您需要一个访问令牌。Buddy允许您生成一个“个人访问令牌”，这使得上手更简易。您可以在您的帐户资料ID中获取。生成令牌时，您需要选择权限范围列表进行数据访问。

oAuth中描述了其他获取令牌的方法

首次检索API数据​

调用API方法的最简单方法是cURL。打开终端并使用先前生成的令牌调用：

$curl https://api.buddy.works/user?access_token=732e9e20-50ba-4047-8a7b-c9b17259a2a2

或作为标头发送令牌

$ curl --header "Authorization: Bearer 732e9e20-50ba-4047-8a7b-c9b17259a2a2" https://api.buddy.works/user

这将以JSON格式接收有关您的帐户资料数据：

响应样本

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/user",
  "html_url": "https://app.buddy.works/my-id",
  "id": 1,
  "name": "Mike Benson",
  "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
  "workspaces_url": "https://api.buddy.works/workspaces"
}

首次从API更新数据​

要更新您的帐户资料，您只需发送一个带有要编辑变量的PATCH：

$ curl -request PATCH --data "{\"title\": \"Buddy is awesome! He's my friend and shit\"}" https://api.buddy.works/user

如有疑问或要求，请直接联系我们 support@buddy.red