1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-27 22:18:36 +02:00
Files
OpenIntegrations/docs/en/md/HTTP-client/Headers-setting/Add-header.mdx
Vitaly the Alpaca (bot) 9be4b23629 Main build (Jenkins)
2025-10-31 15:42:42 +03:00

73 lines
1.8 KiB
Plaintext
Vendored

---
sidebar_position: 2
description: Add header and other functions to work with HTTP-client in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, HTTP-client]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Add header
Adds a header to the request header set
`Function AddHeader(Val Name, Val Value) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | - | String | ✔ | Header key |
| Value | - | String | ✔ | Header value |
Returns: DataProcessorObject.OPI_HTTPClient - This processor object
<br/>
:::caution
**NOCLI:** this method is not available in CLI version
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://bin.openintegrations.dev";
URL = URL + "/get";
Result = OPI_HTTPRequests.NewRequest()
.Initialize()
.SetURL(URL)
.AddHeader("X-Header1", "Value1") // <---
.AddHeader("X-Header2", "Value2") // <---
.ProcessRequest("GET")
.ReturnResponseAsJSONObject();
```
```json title="Result"
{
"args": {},
"headers": {
"Accept": "*/*",
"Accept-Charset": "utf-8",
"Accept-Encoding": "gzip",
"Connection": "Keep-Alive",
"Content-Length": "0",
"Host": "localhost:2424",
"Max-Forwards": "10",
"User-Agent": "1Script v$2.0.0.0",
"X-Arr-Log-Id": "678aae4a-6d91-4a9d-87f9-1b9afde9e1f6",
"X-Arr-Ssl": "2048|256|C=BE, O=GlobalSign nv-sa, CN=GlobalSign GCC R6 AlphaSSL CA 2025|CN=*.openintegrations.dev",
"X-Forwarded-Host": "bin.openintegrations.dev",
"X-Header1": "Value1",
"X-Header2": "Value2",
"X-Original-Url": "/get"
},
"origin": "***",
"url": "https://bin.openintegrations.dev/get"
}
```