600px 中文文档教程

Question

600px

500px.com 包装器，比现有的 500px 节点模块：眨眼：。 包装 500px API，公开一个干净的、经过良好测试的、基于承诺的接口，支持经过身份验证的请求。

Installation

$ npm install 600px

Usage

像往常一样将它要求到您的项目中。 主模块是一个需要正确初始化配置对象的类。 您需要一个用于公共方法的 consumer_key，以及用于经过身份验证的方法的更多信息，我们将在下一节中讨论。

var API = require('600px'),
    api = new API({ consumer_key: 'xxx' });

现在您有一个可用于每个 API 端点的对象，如下所示：

var Photos = api.photos;
var Users = api.users;
var Blogs = api.blogs;
var Collections = api.collections;

有许多方法可以在每个端点上发出特定的 API 请求，如下所述。 目前，仅支持 GET 方法，尽管我计划添加对 POST 和 PUT 方法的支持，并且架构已经到位。

Authorization

该库仅供个人使用，因此不包含完整的授权流程。 如果确实需要授权，则必须通过OAuth在浏览器中进行，可以使用官方维护的500px客户端js库为此。

不幸的是，500px 无法让您轻松获得个人访问令牌，因此您需要了解整个 OAuth 并制作一个虚拟应用程序，以获取您需要的信息来发出经过身份验证的请求。 您可以采取以下一组步骤来相当轻松地获取个人访问令牌：

• Make a new 500px application, make sure to set the callback url to https://grant-oauth.herokuapp.com/connect/500px/callback.
• Head over to the wonderful grant oauth playground, check the app box, and enter in your application's consumer key and secret which you just generated
• Go through the oauth flow. At the end, you will be redirected to grant's playground where you will get a access token and access secret.
• In order to make authenticated calls, you need a consumer_key, consumer_secret, token, and token_secret, which you now have all of. Initialize this library's class with those four, named appropriately, and you will be able to make authenticated calls.

完成此操作后，您可以无误地访问任何端点。 如果没有这个，在 500px 的 API 文档 中指示它们需要 OAuth 的端点将返回错误。

Photos

要检索照片，请使用下面列出的任何方法在实例化类上使用 photos。 一个简短的例子：

api.photos.getPopular({'sort': 'created_at', 'rpp': '100'})
  .catch(console.error)
  .then(console.log);

请注意，每个方法都会返回一个由 when.js 生成的符合 A+ 标准的承诺。 如果您不知道如何使用 promise，请不要担心，基础知识非常简单。 您可以按照上面的示例进行操作：使用 then 在成功时执行一个函数，在错误时使用 catch。 以下是您可以使用的所有与照片相关的功能：

• getById (photo_id, arguments)
• getByUsername (username, arguments)
• getByUserId (user_id, arguments)
• getFavoritesByUsername (username, arguments)
• getFavoritesByUserId (user_id, arguments)
• getFriendsByUsername (username, arguments)
• getFriendsByUserId (user_id, arguments)
• getPopular (arguments)
• getUpcoming (arguments)
• getEditorsChoice (arguments)
• getFreshToday (arguments)
• getFreshYesterday (arguments)
• getFreshWeek (arguments)
• searchByTag (tag, arguments)
• searchByTerm (term, arguments)

有关可能参数的更多信息，请查看 500px.com 照片 API

Users

示例：

api.users.getById(1234)
  .catch(console.error)
  .then(console.log);

可用函数：

• get (arguments)
• getById (id, arguments)
• getByName (username, arguments)
• getByEmail (email, arguments)
• getFriendsById (id, arguments)

有关可能参数的更多信息，请查看 500px.com 用户 API

Blogs

示例：

api.blogs.getFresh()
  .catch(console.error)
  .then(console.log);

函数：

• getById (id, arguments)
• getCommentsById (id, arguments)
• getFresh (arguments)
• getByUsername (username, arguments)
• getByUserId (user_id, arguments)

有关可能参数的更多信息，请查看 500px.com 博客 API

Collections

请注意所有集合端点需要完整的身份验证凭据。

示例：

api.collections.get()
  .catch(console.error)
  .then(console.log);

函数：

• get (arguments)
• getById (id, arguments)

有关可能参数的更多信息，请查看

License

MIT 许可的 500px.com collections API（ 查看许可证 »)