Frequently Asked Questions (FAQ)
General
Q: What is the purpose of the Link Router service?
A: The Link Router service acts as a middleware to route financial messages and facilitate communication between banking systems and blockchain components.
Setup & Configuration
Q: How do I configure the router for my environment?
A: Refer to the environment-setup.md for environment variables and configuration options. You can customize endpoints, queue connections, and integration settings as needed.
Q: What dependencies are required?
A: The service requires Node.js, a supported database, and access to message queues (e.g., ActiveMQ). See getting-started.md for installation steps.
API Usage
Q: How do I create an account?
A: Use the POST /account/create endpoint with the required fields. See api-reference/account-service.md for details.
Q: How do I check a customer's existence?
A: Use the GET /customers/:customerId endpoint. See api-reference/customer-service.md.
Q: How do I send and retrieve messages?
A: Use the POST /messages endpoint to send messages and GET /messages or GET /messages/:id to retrieve them. See api-reference/message-service.md.
Health & Monitoring
Q: How do I check the health of the router?
A: Use the GET /health endpoint for overall system status, or GET /health/queue for queue health.
Troubleshooting
Q: What should I do if I get a 500 Internal Server Error?
A: Check the logs for details. Common causes include misconfiguration, unavailable external services, or invalid request data.
Q: How do I report bugs or request features?
A: Open an issue in the project repository or contact the maintainers as described in CONTRIBUTING.md.
Security
Q: How are sensitive data and credentials managed?
A: Use environment variables and secure vaults for secrets. Never commit sensitive information to source control.
Support
Q: Where can I get help?
A: Refer to the documentation, open issues in the repository, or contact the development team for support.