报告

备注
Expert level
API密钥应作为请求的Authorization标头中的Bearer令牌发送。 获取您的API密钥.
列表

API 端点:

GET 
https://rank.fan/api/v1/reports

请求示例: 

curl --location --request GET 'https://rank.fan/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
参数
类型
描述
search
可选 string
搜索查询。
search_by
可选 string
搜索方式. 可能的值包括：网址 的 url。 默认值：url。
project
可选 string
项目名称。
result
可选 string
The report result. 可能的值包括：好 的 good, 尚可 的 decent, 差 的 bad。
sort_by
可选 string
排序方式. 可能的值包括：创建日期 的 id, 生成日期 的 generated_at, 网址 的 url, 结果 的 result。 默认值：id。
sort
可选 string
排序. 可能的值包括：降序 的 desc, 升序 的 asc。 默认值：desc。
per_page
可选 integer
每页结果数. 可能的值包括：10, 25, 50, 100。 默认值：10。
显示

API 端点:

GET 
https://rank.fan/api/v1/reports/{id}

请求示例: 

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

API 端点:

POST 
https://rank.fan/api/v1/reports

请求示例: 

curl --location --request POST 'https://rank.fan/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. 可能的值包括：公开 的 0, 私有 的 1, 密码 的 2。 默认值：0。
password
可选 string
The password for the report page. Only works with privacy set to 2.
更新

API 端点:

PUT PATCH 
https://rank.fan/api/v1/reports/{id}

请求示例: 

curl --location --request PUT 'https://rank.fan/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
参数
类型
描述
privacy
可选 integer
Report page privacy. 可能的值包括：公开 的 0, 私有 的 1, 密码 的 2。
password
可选 string
The password for the report page. Only works with privacy set to 2.
results
可选 integer
Update the report results. 可能的值包括：否 的 0, 是 的 1。 默认值：0。
删除

API 端点:

DELETE 
https://rank.fan/api/v1/reports/{id}

请求示例: 

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