/api/v2/bpm/extApi

Метод добавляет новую точку доступа к API внешней системы, которая интегрируется с BPMS

application/json

Request Body

• apiName string required

  Possible values: non-empty and <= 255 characters

  Наименование точки доступа к стороннему API

• apiUrl string

  Possible values: non-empty and <= 255 characters

  URL точки доступа к внешнему API

• token string

  Possible values: non-empty and <= 4096 characters

  Токен для авторизации во внешнем апи / access token

• authorization string

  Possible values: non-empty and <= 255 characters

  Тип авторизации (Bearer, ApiKey, Basic)

• signKey string

  Possible values: non-empty and <= 255 characters

  ???Ключ для подписи например, jwt

• encryptKey string

  Possible values: non-empty and <= 255 characters

  ???Ключ для шифрования строки

• expKey int64

  Время действия jwt токена

• headers object

  Заголовки, отправляемые при вызове методов стороннего API

• parentId int64

  ID родительской точки доступа к стороннему API

• enviroment string

  Среда на которой используется сторонний API

Responses

• 201
• 400
• 401

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 1,
  "message": "InstanceListApi is successfully created",
  "response": {
    "id": 84,
    "apiName": "Notion AI",
    "apiUrl": "https://www.notion.so/",
    "token": "pyFunNFO8FIF9bExRAF3sDwZ=m2Bwn/70qR9ZHZZR26zoMMrErJGCSQL",
    "authorization": "API key",
    "signKey": "Vasilii Pupkin",
    "encryptKey": "base64",
    "expKey": 9999,
    "headers": {
      "Content-Type": "application/json"
    },
    "parentId": 66,
    "environment": null
  },
  "preparingsTime": 0.042
}

Bad Request

application/json

• Schema
• Example (from schema)
• example-0
• example-1

---

Schema

• object

{}

400

{
  "status": 0,
  "message": "Required apiName",
  "response": {},
  "preparingsTime": 0.033
}

400_2

{
  "status": 0,
  "message": {
    "apiName": [
      "This field may not be blank."
    ],
    "apiUrl": [
      "This field may not be blank."
    ],
    "signKey": [
      "This field may not be blank."
    ],
    "encryptKey": [
      "This field may not be blank."
    ]
  },
  "response": {},
  "preparingsTime": 0.039
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "status": 0,
  "message": "Authentication credentials were not provided.",
  "response": {
    "detail": "Authentication credentials were not provided."
  },
  "preparingsTime": 0.02
}

Loading...