A Kafka consumer for events where the authentication code is changed or cancelled On the WebFiling side, a Companies House administrative user will have the ability to cancel an company’s authentication code.
| Variable | Description |
|---|---|
| CHS_INTERNAL_API_KEY | Internal API key used to authenticate with CHS internal endpoints |
| ACCOUNT_URL | Base URL for the Accounts API |
| BOOTSTRAP_SERVER_URL | Kafka broker bootstrap servers |
| CHS_KAFKA_ASSOCIATION_ITEMS_PER_PAGE | Page size when fetching CHS association items |
| AUTHCODE_CANCELLATION_TOPIC | Kafka topic for auth code cancellation messages |
| KAFKA_ERROR_TOPIC | Kafka error/dead-letter topic for failed auth code cancellations |
| AUTHCODE_CANCELLATION_GROUP_ID | Kafka consumer group ID for auth code cancellation consumer |
| MAX_ATTEMPTS | Number of times a message is retried before being sent to error topic |
| BACKOFF_DELAY | Delay between retries in milliseconds |
To set up and build the service, follow these steps
- Clone Docker CHS Development and follow the steps in the README.
- Get the broker up by running
chs-dev services enable authcode-changed-consumerin your terminal from the docker-chs-development directory. - Run
chs-dev upin terminal from the docker-chs-development directory. - Run
chs-dev statusto confirm its running