笔记

Expert level

API 密钥应作为请求的授权标头中的承载令牌发送。获取您的 API 密钥.

列表

API端点:

GET

https://rankify.ru/api/v1/reports

请求示例:

curl --location --request GET 'https://rankify.ru/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

范围

类型

描述

search

选修的 string

搜索查询。

search_by

选修的 string

搜索依据. 可能的值有： :值。默认为：：值。

project

选修的 string

项目名称。

result

选修的 string

The report result. 可能的值有： :值。

sort_by

选修的 string

排序方式. 可能的值有： :值。默认为：：值。

sort

选修的 string

种类. 可能的值有： :值。默认为：：值。

per_page

选修的 int

每页结果. 可能的值有： :值。默认为：：值。

展示

API端点:

GET

https://rankify.ru/api/v1/reports/{id}

请求示例:

curl --location --request GET 'https://rankify.ru/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

店铺

API端点:

POST

https://rankify.ru/api/v1/reports

请求示例:

curl --location --request POST 'https://rankify.ru/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

范围

类型

描述

url

必需的 string

The webpage's URL.

privacy

选修的 integer

Report page privacy. 可能的值有： :值。默认为：：值。

password

选修的 string

The password for the report page. Only works with privacy set to 2.

更新

API端点:

PUT PATCH

https://rankify.ru/api/v1/reports/{id}

请求示例:

curl --location --request PUT 'https://rankify.ru/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

范围

类型

描述

privacy

选修的 integer

Report page privacy. 可能的值有： :值。

password

选修的 string

The password for the report page. Only works with privacy set to 2.

results

选修的 integer

Update the report results. 可能的值有： :值。默认为：：值。

删除

API端点:

DELETE

https://rankify.ru/api/v1/reports/{id}

请求示例:

curl --location --request DELETE 'https://rankify.ru/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'

报告