...
If the site uses HTTPS, the API must be accessed via HTTPS as well.
Request Methods
| Type | Details | Example |
|---|---|---|
| JSON POST (Recommended) | The Content-type: application/json field must be passed in the request header for correct data processing on the server. Parameters should be passed in the body of the request in JSON format |
|
| Standard POST (Deprecated) | It is transmitted as standard according to HTTP 1.1 specifications (in the request body). The Content-type: multipart/form-data or Content-type: application/x-www-form-urlencoded header must be passed. | param_1=2¶m_2=4 |
All field names and values should be encoded in UTF-8. Responses are also returned in UTF-8 encoding.
...
- When using UTF-8 encoding in requests, data should be transmitted without the BOM line.
- Responses are similarly returned without BOM.
- It's strongly recommended to use JSON POST requests with
Content-type:application/json header.
Starting from Goodreads version 3.8.0, if you send content via JSON POST method in encoding other than UTF-8, it is necessary to specify it explicitly in the header (for example: "Content-type: application/json; charset=windows-1251").
...
Responses are always in JSON format and include the following fields:
| Field | Meaning | Description |
|---|---|---|
| status | Indicates the status of the request | Possible values:
|
| response | Contains the server's response, dependent on the status and function called. |
JSON POST request example
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"status": "OK",
"response": {"foo": "bar"}
} |
...
Logs of requests and server responses are available at http://<DOMAIN>/api/logs/. To access logs, authenticate in the admin panel at http://<DOMAIN>/edit/login.php using the API login and password.
...
ФункцииOptions:
Page Tree root @self startDepth 3
...