@api-emulator/fidelity
v0.2.2
Published
Fidelity WorkplaceXchange provides workplace participant, retirement, stock-plan, HSA balance, and pay statement APIs.
Readme
@api-emulator/fidelity
Fidelity WorkplaceXchange provides workplace participant, retirement, stock-plan, HSA balance, and pay statement APIs.
Use this emulator for local tests, CI, and offline agent runs. It keeps your tests separate from the production API.
Start the emulator
- Install the package.
npm install @api-emulator/fidelity- From this registry, start the emulator.
npx -p api-emulator api --plugin ./providers/@fidelity/api-emulator.mjs --service fidelityThe emulator uses the local URL that api-emulator prints. Set your client base URL to this local URL.
Supported API
POST /wpx/oauth2/tokenGET /wpx/hrp/v1/participantsGET /wpx/hrp/v1/participants/:participantIdGET /wpx/wi/v1/participants/:participantId/balancesGET /wpx/hrp/v1/participants/:participantId/pay-statementsPOST /wpx/hrp/v1/participantsGET /inspect/contractGET /inspect/state
Coverage
- Level:
smoke-only - Meaning: A smoke test starts the emulator and checks its main behavior.
- Evidence: a direct smoke test exists, but a conformance manifest does not exist.
Credentials
Use a fixed bearer token or API key in each test. The emulator does not send these credentials to the provider.
Test data
Add repeatable test data to the provider configuration.
fidelity:
# Add provider-specific seed state here.