From 6b2c2bea82cc806d9373162135444b930db35cfb Mon Sep 17 00:00:00 2001 From: chenlei Date: Thu, 7 Mar 2024 15:08:25 +0800 Subject: [PATCH] Support for getting a token from a url parameter improve docs --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 43d1f9e..4c9d4d4 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ ### Custom Options **The following settings are optional and not required.** - `-port` or `-p` : Listening port. Default is `1188`. -- `-token` : Access token. If you have set it up, each request will need to include an `Authorization` header. +- `-token` : Access token. If you have set it up, each request will needs to include an `Authorization` header or `token` parameter in the parameters. - `-authkey` : DeepL Official `AuthKey`. If you have set it up, after the 429 response, the official AuthKey will be used for the request. If multiple authKeys are used simultaneously, they need to be separated by commas. #### Requesting a token-protected **DeepLX API** instance using the `curl` @@ -81,6 +81,16 @@ curl -X POST http://localhost:1188/translate \ "target_lang": "DE" }' ``` +or +``` +curl -X POST http://localhost:1188/translate?token=your_access_token \ +-H "Content-Type: application/json" \ +-d '{ + "text": "Hello, world!", + "source_lang": "EN", + "target_lang": "DE" +}' +``` ### Run with Docker ```bash