Dành cho AI agent: markdown của trang này — /docs-content-en/sign-b2e/create-provider.md chỉ mục tài liệu — /llms.txt

Hiện tại, các bài viết trong tài liệu chỉ có bằng tiếng Anh.

Add an external provider

POST /v1/sign-b2e/providers

Registers an external signature provider. Can be called by an administrator via OAuth.

Scopes: sign.b2e.

Available only to an OAuth application key with a user session. An incoming webhook receives 422 BITRIX_ERROR with the native WRONG_AUTH_TYPE code in error.b24Code.

Request body fields

Parameter Type Required Description
Parameterfields Typeobject Requiredyes DescriptionExternal provider fields; values are passed to Bitrix24.
Parameterfields.title Typestring | null Requiredno DescriptionProvider name. The field accepts null; on update, passing null or omitting the field keeps the previous value.
Parameterfields.description Typestring | null Requiredno DescriptionProvider description. The field accepts null; on update, passing null or omitting the field keeps the previous value.
Parameterfields.iconUri Typestring | null Requiredno DescriptionProvider icon URL. The field accepts null; on update, passing null or omitting the field keeps the previous value.
Parameterfields.companyRegUri Typestring | null Requiredno DescriptionCompany registration URL; optional on create. The field accepts null; on update, passing null or omitting the field keeps the previous value.
Parameterfields.documentSignUri Typestring | null Requiredno DescriptionDocument signing URL. The field accepts null; on update, passing null or omitting the field keeps the previous value.
Parameterfields.publicKeyUri Typestring | null Requiredno DescriptionProvider public key URL. The field accepts null; on update, passing null or omitting the field keeps the previous value.

Examples

curl — OAuth application

Terminal
curl -X POST 'https://vibecode.bitrix24.com/v1/sign-b2e/providers' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"fields": {"title": "VIBE-PROBE", "description": "VIBE-PROBE test provider", "iconUri": "https://example.com/icon.png", "documentSignUri": "https://example.com/sign", "publicKeyUri": "https://example.com/public-key"}}'

JavaScript — OAuth application

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/providers', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fields": {"title": "VIBE-PROBE", "description": "VIBE-PROBE test provider", "iconUri": "https://example.com/icon.png", "documentSignUri": "https://example.com/sign", "publicKeyUri": "https://example.com/public-key"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionWhether the request succeeded.
Fielddata Typeobject DescriptionOperation data.
Fielddata.id Typeinteger DescriptionObject ID.
Fieldmeta.redacted Typearray DescriptionPresent when credentials are hidden; contains the paths of the replaced values.

Response example

Shape of a successful response; the data depends on the Bitrix24 account and the request.

JSON
{
  "success": true,
  "data": {
    "id": 7
  }
}

Error response example

403 — the key lacks a required scope:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}

Errors

HTTP Code Reason
HTTP400 CodeINVALID_PARAMS ReasonInvalid request shape: types, required fields or an unknown query string parameter.
HTTP401 CodeTOKEN_MISSING ReasonNo credentials for the Bitrix24 connection.
HTTP403 CodeSCOPE_DENIED ReasonOne of the required scopes is not granted.
HTTP422 CodeBITRIX_ERROR ReasonBitrix24 rejected the operation; the code is in error.b24Code, the text in error.message.
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY ReasonThe key is read-only.
HTTP422 CodeBITRIX_ERROR ReasonAn incoming webhook was used instead of OAuth. The native WRONG_AUTH_TYPE code is in error.b24Code.

Common API errors.

Known specifics

Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.

The operation is not retried automatically. If the outcome is unknown, check the state in the Bitrix24 account first; a repeated call can perform the operation again.

See also