jaybizzle/rankinity-api

Rankinity API 的简单 PHP 封装

v1.0.0 2016-03-02 22:28 UTC

This package is auto-updated.

Last update: 2024-09-06 09:04:05 UTC


README

Build Status StyleCI Total Downloads

安装

"jaybizzle/rankinity-api": "1.*" 添加到您的 composer.json 文件中。

用法

您可以在此处阅读官方 Rankinity API 文档 - http://my.rankinity.com/api.en

您可以通过在名称前加上 get 来调用所有 Rankinity API 端点,例如:

use Jaybizzle\Rankinity;

$r = new Rankinity('YOUR_API_KEY');

// get all projects
$projects = $r->getProjects();

大多数 Rankinity API 端点都可以接受查询字符串参数,例如 sort_property 用于排序返回的结果。以上述项目为例,我们可以这样做...

$projects = $r->sortProperty('name')->getProjects();

这些也可以链式调用...

$projects = $r->sortProperty('name')->sortAscending('false')->getProjects();

更多示例...

//  list of competitors
$competitors = $r->project('project_id')->getCompetitors();

// list of keywords
$keywords = $r->project('project_id')->getKeywords();

// list of keyword groups
$groups = $r->project('project_id')->getGroups();

// list of ranks
$ranks = $r->project('project_id')->searchEngine('search_engine_id')->getRanks();

注意:查询参数在 Rankinity API 文档中以 snake_case 列出,但我们可以使用 camelCase 方法来访问它们,因此所有方法调用都有统一的命名约定。