Phish AI API 使用教程

Phish AI API 使用教程

phish-ai-apiOfficial python API for Phish.AI public and private API to detect zero-day phishing websites项目地址:https://gitcode.com/gh_mirrors/ph/phish-ai-api

1. 项目的目录结构及介绍

phish-ai-api/
├── LICENSE
├── README.md
├── phish_ai_api/
│   ├── __init__.py
│   ├── api.py
│   └── utils.py
└── setup.py

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• phish_ai_api/: 项目的主要代码目录。
  • __init__.py: 模块初始化文件。
  • api.py: 主要API接口实现。
  • utils.py: 工具函数和辅助功能。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 api.py，其中包含了主要的API接口实现。以下是 api.py 的基本结构：

from __future__ import print_function
from phish_ai_api import API

ph = API(api_key='None or private api key you can request at info@phish.ai')
res = ph.scan_url('https://google.com')
print(res)
print(ph.get_report(res['scan_id']))

• API 类：用于与 Phish AI API 进行交互。
• scan_url 方法：用于扫描指定的 URL。
• get_report 方法：用于获取扫描报告。

3. 项目的配置文件介绍

项目没有显式的配置文件，但可以通过 API 类的构造函数传递 api_key 进行配置。以下是配置示例：

from phish_ai_api import API

ph = API(api_key='your_private_api_key')

• api_key: 用于身份验证的 API 密钥，可以从 info@phish.ai 请求获取。

通过以上配置，可以初始化 API 对象并进行 URL 扫描和报告获取。

phish-ai-apiOfficial python API for Phish.AI public and private API to detect zero-day phishing websites项目地址:https://gitcode.com/gh_mirrors/ph/phish-ai-api