Skip to content

DOC: readme add api doc #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bossa573 merged 2 commits into from
Jun 3, 2021
Merged

DOC: readme add api doc #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c260bdf
DOC: readme add api doc
lryong Jun 3, 2021
f1381b1
Update README.md
Bossa573 Jun 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,16 @@ func main() {

For more detailed documentation, please check on godoc.org 👉 [email-verifier](https://godoc.org/github.com/AfterShip/email-verifier)

## API

We provide a simple **self-hosted** [API server](https://github.com/AfterShip/email-verifier/tree/main/cmd/apiserver) script for reference.

The API interface is very simple. All you need to do is to send a GET request with the following URL.

The `email` parameter would be the target email you want to verify.

`https://{your_host}/v1/{email}/verification`

## Similar Libraries Comparison

| | [email-verifier](https://github.com/AfterShip/email-verifier) | [trumail](https://github.com/trumail/trumail) | [check-if-email-exists](https://reacher.email/) | [freemail](https://github.com/willwhite/freemail) |
Expand All @@ -176,8 +186,8 @@ For more detailed documentation, please check on godoc.org 👉 [email-verifier]
| Honeyport dection | 🔜 | ❌ | ❌ | ❌ |
| Bounce email check | 🔜 | ❌ | ❌ | ❌ |
| **Tech** | 〰️ | 〰️ | 〰️ | 〰️ |
| Provide API | 🔜 | ✅ | ✅ | ❌ |
| Free API | 🔜 | ❌ | ❌ | ❌ |
| Provide API | ✅ | ✅ | ✅ | ❌ |
| Free API | ✅ | ❌ | ❌ | ❌ |
| Language | Go | Go | Rust | JavaScript |
| Active maintain | ✅ | ❌ | ✅ | ✅ |
| High Performance | ✅ | ❌ | ✅ | ✅ |
Expand Down