API Usage Policy

Policies about usage of the OERSI API
Tags:
Categories:

  less than a minute  

User Agent

When using the OERSI API, please send a meaningful, recurring string as a User-Agent in the http request header. This allows us to identify usage patterns in the statistical analysis of the API and improve our services from the insights gained. It also allows us to contact you, if needed.

The generic format of the User Agent is <client name> (<contact information, for example Email, Service-address>) <library/framework name>/<version>. Parts that are not applicable can be omitted.

If you use an automated client that accesses the API directly: Do not copy a browser’s user agent for your bot. Do not use generic agents such as “curl”, “python-requests/x”,…

Examples

Python

import requests

url = 'https://oersi.org/resources/api/...'
headers = {'User-Agent': 'MyBot/1.0 (https://example.org/mybot/; mybot@example.org)'}
response = requests.get(url, headers=headers)

curl

curl --user-agent "MyBot/1.0 (https://example.org/mybot/; mybot@example.org)" https://oersi.org/resources/api/...