Skip to content

Commit

Permalink
GITBOOK-13: Fix bulk proxy endpoint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
amaury@reacher.email authored and gitbook-bot committed Oct 15, 2024
1 parent 08ee6c5 commit 5d3979a
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/self-hosting/bulk.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The default Reacher API only exposes one endpoint, `/v0/check_email`, which allo

When running the Reacher backend, set two new environment variables:

*  `RCH_ENABLE_BULK=1`
* &#x20;`DATABASE_URL=<your_postgres_db>`
* `RCH_ENABLE_BULK=1`
* `DATABASE_URL=<your_postgres_db>`

For example, if running with docker, run

Expand All @@ -34,8 +34,6 @@ Server is listening on 0.0.0.0:8080.

## How does Bulk email verification work?

&#x20;

<figure><img src="https://www.notion.so/image/https%3A%2F%2Ffile.notion.so%2Ff%2Ff%2F8fc90893-c1e2-426b-8b22-6e4e323244db%2F3fff2c3e-e65f-4306-abbd-b4037760b517%2Fbulk.svg%3Ftable%3Dblock%26id%3D2090bf73-99bb-462b-90f2-57b0af6733ab%26spaceId%3D8fc90893-c1e2-426b-8b22-6e4e323244db%26expirationTimestamp%3D1726833600000%26signature%3DCMRYdgntz2SsZnL8Krlve4pJS6mUB666K64SV9CiTHM?table=block&#x26;id=2090bf73-99bb-462b-90f2-57b0af6733ab&#x26;cache=v2" alt="Flow chart describing the bulk verification process."><figcaption><p>Flow chart describing the bulk verification process.</p></figcaption></figure>

Bulk email verification is done in 3 steps:
Expand All @@ -56,7 +54,7 @@ The body of the request contains the list of emails, as well as a couple of conf
// All fields below are optional:
"proxy": {
"host": "my.proxy.com",
"port": "9080",
"port": 9080,
"username": "user", // Optional authentication for proxy.
"password": "pass",
},
Expand Down Expand Up @@ -119,12 +117,12 @@ To avoid returning a huge JSON payload, the `results` array by default only retu
* `?offset=<n>`: The offset from which we return the results, which is equivalent to the number of elements in the array to skip. Defaults to `0`.
* `?limit=<n>`: The number of results to return. Defaults to `50`.

For example, if your initial input has 100 emails to verify, and you want the results for emails #61-#70, you should add the query parameters: `GET /v0/bulk/{job_id}/results?offset=60&limit=10`.&#x20;
For example, if your initial input has 100 emails to verify, and you want the results for emails #61-#70, you should add the query parameters: `GET /v0/bulk/{job_id}/results?offset=60&limit=10`.

{% hint style="success" %}
Pro Tip: You can also download the results as CSV, by passing the `?format=csv` query paramter: `GET /v0/bulk/{job_id}/results?format=csv`.
{% endhint %}

## Questions?

This Bulk email verification feature is still new, so feel free to send me an email [amaury](https://app.gitbook.com/u/F1LnsqPFtfUEGlcILLswbbp5cgk2 "mention").
This Bulk email verification feature is still new, so feel free to send me an email [amaury@reacher.email](https://app.gitbook.com/u/F1LnsqPFtfUEGlcILLswbbp5cgk2 "mention").

0 comments on commit 5d3979a

Please sign in to comment.