在官网登录后,点击顶部导航栏中的 Developer API,即可创建、复制和撤销 API Key。
Base URL: https://verigo.site。完整机器可读规范见 OpenAPI JSON。
认证
先创建 Verigo 账户并登录。通过登录会话创建 API Key,密钥只在创建响应中出现一次,请立即保存在安全的密钥管理工具中。
GET /api/auth/api-keys 列出,并用 DELETE /api/auth/api-keys/{key_id} 立即撤销。提交与查询
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /api/jobs | 提交批量邮箱验证任务;按任务中的邮箱数量消耗账户额度。 |
| GET | /api/jobs/{job_id} | 获取任务状态、进度和汇总。 |
| GET | /api/jobs/{job_id}/results | 分页读取结果,可使用 offset、limit、search、deliverability 过滤。 |
| GET | /api/jobs/{job_id}/download | 任务完成后下载 CSV 结果。 |
| GET | /api/jobs | 读取近期任务,limit 范围为 1-50。 |
| POST | /api/jobs/{job_id}/stop | 停止正在执行的任务。 |
| POST | /api/jobs/{job_id}/resume | 继续已停止任务中尚未完成的邮箱。 |
| GET | /api/wallet | 读取可用验证额度与使用记录。 |
| POST | /api/discovery/candidates | 按姓名和域名生成候选邮箱地址。 |
示例
After signing in, open Developer API from the top navigation to create, copy, and revoke API keys.
Base URL: https://verigo.site. The machine-readable specification is available as OpenAPI JSON.
Authentication
Create a Verigo account and sign in first. API keys are created with a browser session and their full value is shown only once. Store it in a secure secret manager immediately.
GET /api/auth/api-keys and revoke one immediately with DELETE /api/auth/api-keys/{key_id}.Submit and Query
| Method | Path | Description |
|---|---|---|
| POST | /api/jobs | Submit a bulk email-verification job. Credits are consumed by the number of email addresses in the job. |
| GET | /api/jobs/{job_id} | Retrieve a job's status, progress, and summary. |
| GET | /api/jobs/{job_id}/results | Read paginated results. Filter with offset, limit, search, and deliverability. |
| GET | /api/jobs/{job_id}/download | Download CSV results after a job completes. |
| GET | /api/jobs | Read recent jobs. limit ranges from 1 to 50. |
| POST | /api/jobs/{job_id}/stop | Stop a running job. |
| POST | /api/jobs/{job_id}/resume | Resume unprocessed addresses in a stopped job. |
| GET | /api/wallet | Retrieve available verification credits and usage history. |
| POST | /api/discovery/candidates | Generate candidate email addresses from a name and domain. |
Examples
curl -c cookies.txt -X POST https://verigo.site/api/auth/login \
-H "Content-Type: application/json" \
-d '{"account":"you@example.com","password":"your-password"}'
curl -b cookies.txt -X POST https://verigo.site/api/auth/api-keys \
-H "Content-Type: application/json" \
-d '{"name":"production"}'
curl -X POST https://verigo.site/api/jobs \
-H "Authorization: Bearer vg_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{"emails":["alice@example.com","bob@example.com"],"worker_count":2}'
curl https://verigo.site/api/jobs/JOB_ID/results?limit=100 \
-H "X-API-Key: vg_live_your_api_key"
响应与限制
成功的任务创建返回 202;认证失败返回 401;额度不足或无效请求返回 422;队列繁忙返回 429。单任务上限与并发限制由账户服务配置决定。
Responses and Limits
Successful job creation returns 202; authentication failure returns 401; insufficient credits or invalid requests return 422; and a busy queue returns 429. Per-job and concurrency limits are configured by the account service.