The Wine Lister API implements the REST architectural style and supports HTTP methods for interacting with resources. Our API has resource-oriented URLs and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication. JSON is returned by all API responses, including errors.
Our API uses HTTP Basic authentication to authenticate requests. Enter any string as your username and supply your API Secret Key as the password. Here's a quick example that shows how to authenticate:
curl --request GET \
--url 'https://api.wine-lister.com/1.0/wine?id=3720' \
--user 'anystring:<your_api_secret_key>'
We give a valid, signed certificate for all API methods. All API requests must be made over HTTPS.
Query string parameters in requests must be UTF-8 character encoded and url-encoded. Our responses are UTF-8 character encoded. For example:
curl --request GET -G \
--url 'https://api.wine-lister.com/1.0/wine' \
--data-urlencode 'title=Château Margaux Premier Cru' \
--user 'anystring:<your_api_secret_key>'
Wine Lister uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g. a resource could not be found), and codes in the 5xx range indicate an error with Wine Lister's servers.
| Endpoint | HTTP Method | Function |
|---|---|---|
| /wine | Get information about a wine |