README

简介

SimilarWeb 是由 SimilarGroup 公司创建的项目。它收集并提供了各种网站分析数据的访问权限。这是一个实现轻松访问其 API 的 PHP 库。

需求

PHP 5.3 (命名空间)，
php-curl-class 库（Curl 请求库）。

安装

此库可在 Packagist 上找到，并使用 merlinoff/SimilarWebApi 别名。如果您使用 Composer（如果您没有，我真的不知道您在等什么），您可以使用 composer require 安装它

composer require merlinoff/similar-web-api

或者您可以直接在您的 composer.json 中放置它

(...)
"require": {
    "merlinoff/similar-web-api": "dev-master"
}
(...)

然后根据需要运行 composer install 或 composer update。

当然，您也可以将其作为 git submodule，下载并将其放置在您的项目旁边，与常规代码一起或类似的东西，但真的，做点好事（以及整个行业）并使用 Composer。

使用方法

在此库中实现的所有 API 都具有与 SimilarWeb API 文档中定义的名称相对应的请求和响应类。预期数据应通过首先访问 SimilarWeb API 文档，然后使用位于 src/Request 目录中的具有相同名称的请求类来检索。下面演示的 getResponse() 方法将自动匹配、创建并返回匹配的响应类对象，该对象可以类型提示并依赖。还有一个 ClientFacade 类，它包含易于使用的接口（请注意，此类是自动生成的）

use merlinoff\SimilarWeb;

// create client object
$sw = new SimilarWeb($token);
$sw->setDomain("google.com");

// fetch response by passing API call name and desired domain
$result = $sw->getRankAndReach();


// or get category rank
$result = $sw->getCategoryRank();


// or get Traffic
$result = $sw->getTraffic("9-2014", "2-2015");

etc...

API 返回具有包含四种类型数据键的对象

在执行 composer install、composer update 或手动执行 php bin/generate 命令期间，使用 API 映射配置来生成具有隐藏库复杂性的可读访问器的域请求和响应类。这种方法使得拥有可读的类 API、良好的 IDE 自动完成和突出显示功能成为可能，而无需额外的编程工作。当解析响应时，给定类型的所有元素都放入其容器中，这些响应类作为原始响应对象的门面。

许可证

GNU 通用公共许可证

merlinoff / similar-web-api

维护者

详细信息

README

简介

需求

安装

使用方法

许可证