AparteAdmin

Get the Aparte configuration

get

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

/api/{tenantId}/admin/extensions/aparte

Returns the non-secret Aparte configuration for this tenant and whether an API key is currently stored. Returns 404 when Aparte is not configured. The API key itself is never returned.

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 Aparte configuration.

baseUrlstring · uriRequired

Root URL of the Aparte WalletCrew API.

tenantstring · min: 1Required

Tenant identifier sent as the X-Tenant header.

defaultPassTypestring · min: 1Required

Default pass type assigned to passes created from Aparte tickets.

hasApiKeybooleanRequired

Whether an API key is currently stored in the secret repository.

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller lacks required scope.

text/plainapplication/jsontext/json

404

Aparte is not configured for this tenant.

text/plainapplication/jsontext/json

get

/api/{tenantId}/admin/extensions/aparte

HTTPcURLJavaScriptPython

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

{
  "baseUrl": "https://example.com",
  "tenant": "text",
  "defaultPassType": "text",
  "hasApiKey": true
}

Set Aparte configuration

put

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

/api/{tenantId}/admin/extensions/aparte

Validates credentials against the Aparte WalletCrew API, then saves the configuration to server/aparte.yml. Omit apiKey to update settings without rotating the secret (the existing stored key is used for the credential check).

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 Aparte configuration.

baseUrlstring · uriRequired

Root URL of the Aparte WalletCrew API.

tenantstring · min: 1Required

Tenant identifier sent as the X-Tenant header.

defaultPassTypestring · min: 1Required

Default pass type assigned to passes created from Aparte tickets.

apiKeystring · nullableOptional

API key sent as the X-Api-Key header. Stored in the secret repository under APARTE-APIKEY. When omitted, the existing secret is preserved.

Responses

204

Configuration saved.

400

Request body is invalid or the credentials failed to validate against the Aparte API.

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/aparte

HTTPcURLJavaScriptPython

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

{
  "baseUrl": "https://example.com",
  "tenant": "text",
  "defaultPassType": "text",
  "apiKey": null
}

application/jsontext/jsonapplication/*+json

No content

Delete Aparte configuration

delete

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

/api/{tenantId}/admin/extensions/aparte

Removes server/aparte.yml from tenant configuration and deletes the stored API key.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

204

Configuration deleted.

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller lacks required scope.

text/plainapplication/jsontext/json

delete

/api/{tenantId}/admin/extensions/aparte

HTTPcURLJavaScriptPython

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

No content