forked from pramsey/pgsql-http
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add user-agent exaplanation in README
- Loading branch information
1 parent
eb0711b
commit f148812
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -155,6 +155,29 @@ FROM | |
--------+----------------------------------------------------------- | ||
302 | http://www.google.ch/?gfe_rd=cr&ei=ACESWLy_KuvI8zeghL64Ag | ||
``` | ||
|
||
Using this extension as a background automated process without supervision (e.g as a trigger) may have unintended consequences for other servers. | ||
It is considered a best practice to share contact information with your requests, | ||
so that administrators can reach you in case your HTTP calls get out of control. | ||
|
||
Certain API policies (e.g. [Wikimedia User-Agent policy](https://meta.wikimedia.org/wiki/User-Agent_policy)) may even require sharing specific contact information | ||
with each request. Others may disallow (via `robots.txt`) certain agents they don't recognize. | ||
|
||
For such cases you can set the `CURLOPT_USERAGENT` option | ||
|
||
```sql | ||
SELECT http_set_curlopt('CURLOPT_USERAGENT', | ||
'Examplebot/2.1 (+http://www.example.com/bot.html) Contact [email protected]'); | ||
|
||
SELECT content::json ->> 'user-agent' FROM http_get('http://httpbin.org/user-agent'); | ||
``` | ||
``` | ||
status | user_agent | ||
--------+----------------------------------------------------------- | ||
200 | Examplebot/2.1 (+http://www.example.com/bot.html) Contact [email protected] | ||
``` | ||
|
||
|
||
## Concepts | ||
|
||
Every HTTP call is a made up of an `http_request` and an `http_response`. | ||
|