TABLE OF CONTENTS
Introduction
This article is a step-by-step guide to help developers and customers to debug and trouble shoot the issues and resolve common issues in the Znode Apis (V1& V2). Ideal for teams working with .net core. It outlines into two main sections one is for troubleshooting the issues and its history and another is for developers to debug the issue in a web store or Pagebuilder.
Troubleshooting & Debugging (App Development)
Client Issues History
| Issue Description | Error creating new Account via API |
| Error creating new Account via API | - The account creation flow has been updated to automatically associate new accounts with a portal, based on the store code provided in the API request.
|
| Type of Issue | Code issue |
| Solution | Implemented logic in the account creation API to automatically associate new accounts with the correct portal by using the storeCode provided in the request. |
| Issue Description | NewsLetter Clarification needed regarding the newly introduced Newsletter Feature and its implementation. |
| Troubleshooting or RCA Details | A new API was developed to support the newsletter functionality. This API is responsible for retrieving newsletter subscriber data from the database. |
| Type of Issue | Feature Implementation missing |
| Solution | - Developed and configured a new API endpoint to fetch newsletter subscriber information from the database, enabling seamless integration with the newsletter system.
|
| Issue Description | Tag-based Blog Retrieval Issue |
| Troubleshooting or RCA Details | Stored procedure Znode_GetBlogNewsList was not returning Tags data, causing incomplete results for tag-based blog/news retrieval. |
| Type of Issue | Data issue -Stored Procedure Bug / Data Retrieval Issue |
| Solution | - Updated Znode_GetBlogNewsList to include Tags column, enabling correct filtering of blog and news posts by tags.
|
| Issue Description | Error setting up user role via Znode API |
| Troubleshooting or RCA Details | User creation didn’t fully support account-code linkage or role handling, causing role assignment errors and incomplete user data. |
| Type of Issue | Missing -API Enhancement / User Role Management |
| Solution | - Added CreateCustomerByAccountCode method with B2B role validation, enhanced response details, updated AutoMapper, and conditional profile association.
|
| Issue Description | Missing Authorization Key Results in 401 Error |
| Troubleshooting or RCA Details | When the Authorization header is not included in the API request, the server returns a 401 Unauthorized status code with an error message indicating missing or invalid token credentials. |
| Type of Issue | Authentication / Security |
| Solution | - Include a valid Authorization header in all API requests using Basic authentication:
- Authorization: Basic <base64-encoded-credentials>
- Example Authorization: Basic d3d3Lm15LXN0b3JlLmNvbXw1RDJCNEM1RS1EOEIzLTQ0ODgtOTA0RC02NDA5NDc2MkUxMzY=
|
| Issue Description | RabbitMQ Connection Failure Causes Stale Data |
| Troubleshooting or RCA Details | When the RabbitMQ connection is invalid or fails, the system cannot receive updated messages from the queue, leading to the use of outdated cached data and resulting in data inconsistency issues. |
| Type of Issue | Connection Issue |
| Solution | - Ensure the RabbitMQ connection string and credentials are correct and stable.
- Implement retry mechanisms to handle temporary connection failures.
- Set up monitoring to promptly detect RabbitMQ connection issues.
- Enable automatic recovery to minimize downtime.
|
| Issue Description | Database connection failure causing API downtime or errors. |
| Troubleshooting or RCA Details | Incorrect connection strings or expired credentials lead to failed database connectivity. |
| Type of Issue | Data issue: Database / Connectivity |
| Solution | Verify and update DB connection strings and credentials.
Log all connection errors.
|
| Issue Description | API rejecting requests due to invalid or missing input data. |
| Troubleshooting or RCA Details | Missing or malformed request parameters cause validation failures. |
| Type of Issue | Missing Validation / Input |
| Solution | validate and sanitize inputs, enforce required fields, return clear errors, and log invalid requests.
|
