Comarch

Get the Comarch configuration

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/extensions/comarch

Returns the current Comarch configuration for this tenant. Secret values are never returned; the response contains hasClientSecret and kafkaConnection.hasPassword so callers can determine whether required secrets are already configured. Returns 404 when Comarch is not configured.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Configuration returned.

text/plainapplication/jsontext/json

Response body for Comarch configuration.

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller lacks required scope.

text/plainapplication/jsontext/json

404

Comarch is not configured for this tenant.

text/plainapplication/jsontext/json

get/api/{tenantId}/admin/extensions/comarch

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/extensions/comarch HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "connection": {
    "baseUrl": "https://example.com",
    "clientId": "text",
    "programCode": "text",
    "partnerCode": "text",
    "hasClientSecret": true
  },
  "providers": {
    "customer": {
      "retrieveCustomerTransactionBalance": false
    }
  },
  "kafkaConnection": {
    "bootstrapServers": "text",
    "username": "text",
    "topic": "text",
    "hasPassword": true
  },
  "rateLimit": {
    "throttlingLimit": 80
  }
}

Set Comarch configuration

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/extensions/comarch

Creates or updates Comarch configuration. Omit connection.clientSecret to keep the currently stored client secret. When kafkaConnection is provided, omit kafkaConnection.password to keep the currently stored Kafka password. When kafkaConnection is omitted, Kafka configuration is removed. Returns 400 if a required secret is missing and no previously stored value exists.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request body for setting Comarch configuration.

Responses

204

Configuration saved.

No content

400

Request body is invalid or a client secret is required but missing.

text/plainapplication/jsontext/json

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller lacks required scope.

text/plainapplication/jsontext/json

put/api/{tenantId}/admin/extensions/comarch

HTTPcURLJavaScriptPython

PUT /api/{tenantId}/admin/extensions/comarch HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "connection": {
    "baseUrl": "https://example.com",
    "clientId": "text",
    "programCode": "text",
    "partnerCode": "text",
    "clientSecret": null
  },
  "providers": {
    "customer": {
      "retrieveCustomerTransactionBalance": false
    }
  },
  "kafkaConnection": {
    "bootstrapServers": "text",
    "username": "text",
    "topic": "text",
    "password": null
  },
  "rateLimit": {
    "throttlingLimit": 80
  }
}

application/jsontext/jsonapplication/*+json

No content

Delete Comarch configuration

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/extensions/comarch

Removes Comarch configuration for the tenant and deletes stored Comarch secrets. This operation is idempotent: it succeeds even when configuration or secrets are already absent.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

204

Configuration deleted.

No content

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller lacks required scope.

text/plainapplication/jsontext/json

delete/api/{tenantId}/admin/extensions/comarch

HTTPcURLJavaScriptPython

DELETE /api/{tenantId}/admin/extensions/comarch HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content