CustomerServiceImpl

string

Идентификатор Spring bean, который содержит вызываемый сервис.customerServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST. Bearer Token: не требуется.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

SellerRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getRepository

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getRepository",
  "args": []
}

Deque<Map<String, Object>>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getPaginationCustomers

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationCustomers",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`verificationToken`	`String`	Передаётся через `args[0].0`.

validateVerificationToken

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "validateVerificationToken",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`passwordResetToken`	`String`	Передаётся через `args[0].0`.

validatePasswordResetToken

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "validatePasswordResetToken",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`userAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

sendVerificationEmail

Пример JSON объекта запроса:

{
    "id":  null,
    "username":  null,
    "password":  null,
    "savedPassword":  null,
    "fallIntoObjects":  null,
    "active":  false,
    "roles":  null,
    "permissions":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "sendVerificationEmail",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Аргумент	Тип	Описание
`requestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

searchCustomers

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCustomers",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Аргумент	Тип	Описание
`requestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

searchCustomersLightweight

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCustomersLightweight",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Seller>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getCustomersPaged

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCustomersPaged",
  "args": [
    {
      "0": null
    }
  ]
}

Seller

Аргумент	Тип	Описание
`customerAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

registerCustomerFull

Пример JSON объекта запроса:

{
    "id":  null,
    "stripeCustomerId":  null,
    "stripeConnectId":  null,
    "address":  null,
    "shippingAddresses":  null,
    "companyName":  null,
    "vatNumber":  null,
    "numberOfEmployees":  null,
    "sellerType":  null,
    "sellerTariff":  null,
    "subscription":  null,
    "companyEmailAddress":  null,
    "companyPhone":  null,
    "companyWebSite":  null,
    "imageURLs":  null,
    "documentURLs":  null,
    "description":  null,
    "profiles":  null,
    "certificates":  null,
    "sellerSKUs":  null,
    "ordersBuyer":  null,
    "ordersVendor":  null,
    "favoriteSellersIds":  null,
    "favoriteSellerSkuIds":  null,
    "sellerCategoriesIds":  null,
    "sellerProductsIds":  null,
    "emailNotifications":  false,
    "onlineActive":  false
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "registerCustomerFull",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<Profile>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchEmployees

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchEmployees",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Profile>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchEmployeesPaged

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchEmployeesPaged",
  "args": [
    {
      "0": null
    }
  ]
}

Profile

Аргумент	Тип	Описание
`userProfileAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

registerCustomerSimplified

Пример JSON объекта запроса:

{
    "id":  null,
    "user":  null,
    "firstName":  null,
    "lastName":  null,
    "website":  null,
    "phone":  null,
    "mobilePhone":  null,
    "birthday":  null,
    "emailAddress":  null,
    "gender":  null,
    "salutation":  null,
    "embeddedParent":  null,
    "emailNotifications":  false,
    "imageURLs":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "registerCustomerSimplified",
  "args": [
    {
      "0": null
    }
  ]
}

Seller

Аргумент	Тип	Описание
`sellerAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

updateCustomer

Пример JSON объекта запроса:

{
    "id":  null,
    "stripeCustomerId":  null,
    "stripeConnectId":  null,
    "address":  null,
    "companyName":  null,
    "vatNumber":  null,
    "numberOfEmployees":  null,
    "sellerType":  null,
    "sellerTariff":  null,
    "subscription":  null,
    "companyEmailAddress":  null,
    "companyPhone":  null,
    "companyWebSite":  null,
    "description":  null,
    "imageURLs":  null,
    "shippingAddresses":  null,
    "documentURLs":  null,
    "profileIds":  null,
    "certificateIds":  null,
    "sellerSkuIds":  null,
    "ordersAsBuyerIds":  null,
    "ordersAsVendorIds":  null,
    "favoriteSellersIds":  null,
    "favoriteSellerSkuIds":  null,
    "sellerCategoriesIds":  null,
    "sellerProductsIds":  null,
    "emailNotifications":  false,
    "onlineActive":  false,
    "imageUrlRemove":  false,
    "metaInfo":  null,
    "createdBy":  null,
    "createdDate":  null,
    "lastModifiedBy":  null,
    "lastModifiedDate":  null,
    "alias":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCustomer",
  "args": [
    {
      "0": null
    }
  ]
}

Profile

Аргумент	Тип	Описание
`userProfileAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

updateCustomerProfile

Пример JSON объекта запроса:

{
    "id":  null,
    "user":  null,
    "firstName":  null,
    "lastName":  null,
    "website":  null,
    "phone":  null,
    "mobilePhone":  null,
    "birthday":  null,
    "emailAddress":  null,
    "gender":  null,
    "salutation":  null,
    "embeddedParent":  null,
    "emailNotifications":  false,
    "imageURLs":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCustomerProfile",
  "args": [
    {
      "0": null
    }
  ]
}

SellerDTO

Аргумент	Тип	Описание
`customerAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

mapSellerToDto

Пример JSON объекта запроса:

{
    "id":  null,
    "stripeCustomerId":  null,
    "stripeConnectId":  null,
    "address":  null,
    "shippingAddresses":  null,
    "companyName":  null,
    "vatNumber":  null,
    "numberOfEmployees":  null,
    "sellerType":  null,
    "sellerTariff":  null,
    "subscription":  null,
    "companyEmailAddress":  null,
    "companyPhone":  null,
    "companyWebSite":  null,
    "imageURLs":  null,
    "documentURLs":  null,
    "description":  null,
    "profiles":  null,
    "certificates":  null,
    "sellerSKUs":  null,
    "ordersBuyer":  null,
    "ordersVendor":  null,
    "favoriteSellersIds":  null,
    "favoriteSellerSkuIds":  null,
    "sellerCategoriesIds":  null,
    "sellerProductsIds":  null,
    "emailNotifications":  false,
    "onlineActive":  false
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "mapSellerToDto",
  "args": [
    {
      "0": null
    }
  ]
}

Клиенты для интеграции

Клиенты

Сервисы

REST API

Headers

Методы

getRepository

getPaginationCustomers

validateVerificationToken

validatePasswordResetToken

sendVerificationEmail

searchCustomers

searchCustomersLightweight

getCustomersPaged

registerCustomerFull

searchEmployees

searchEmployeesPaged

registerCustomerSimplified

updateCustomer

updateCustomerProfile

mapSellerToDto

​Headers

​Методы

​getRepository

​getPaginationCustomers

​validateVerificationToken

​validatePasswordResetToken

​sendVerificationEmail

​searchCustomers

​searchCustomersLightweight

​getCustomersPaged

​registerCustomerFull

​searchEmployees

​searchEmployeesPaged

​registerCustomerSimplified

​updateCustomer

​updateCustomerProfile

​mapSellerToDto

Headers

Методы

getRepository

getPaginationCustomers

validateVerificationToken

validatePasswordResetToken

sendVerificationEmail

searchCustomers

searchCustomersLightweight

getCustomersPaged

registerCustomerFull

searchEmployees

searchEmployeesPaged

registerCustomerSimplified

updateCustomer

updateCustomerProfile

mapSellerToDto