1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-18 09:51:28 +02:00
Files
OpenIntegrations/docs/en/md/HTTP/Headers-setting/Add-header.mdx
T
Vitaly the Alpaca (bot) 23edbc8efb Main build (Jenkins)
2026-05-02 20:20:36 +03:00

92 lines
2.6 KiB
Plaintext
Vendored

---
sidebar_position: 2
sidebar_class_name: doc-no-cli
description: Add header and other functions to work with HTTP 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]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Admonition from '@theme/Admonition';
# Add header
Adds a header to the request header set
<Tabs>
<TabItem value="params" label="Parameters" default>
`Function AddHeader(Val Name, Val Value, Val IgnoreEmpty = False) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | - | String | &#x2714; | Header key |
| Value | - | String | &#x2714; | Header value |
| IgnoreEmpty | - | Boolean | &#x2716; | Do not add header if empty value is passed |
<div className="return-value-note">
<div className="return-value-note__title">Returns</div>
<div className="return-value-note__value">
DataProcessorObject.OPI_HTTPClient - This processor object
</div>
</div>
</TabItem>
<TabItem value="extended" label={<span>Advanced call{' '}<a href="/docs/Start/Advanced-call" target="_blank" rel="noreferrer" title="About advanced call" onClick={(e) => e.stopPropagation()}>?</a></span>}>
*This method has no additional advanced call parameters.*
</TabItem>
</Tabs>
<Admonition type="caution" title="Caution" className="nocli-admonition">
<div className="addin">
<strong>NOCLI:</strong> this method is not available in CLI version
</div>
</Admonition>
```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": "bin.openintegrations.dev",
"Max-Forwards": "10",
"User-Agent": "1Script v$2.0.1.0",
"X-Arr-Log-Id": "06e71851-a56b-4179-8f28-87fb7df60cb7",
"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": "***"
},
"origin": "***",
"url": "https://bin.openintegrations.dev/get"
}
```