Handling Errors, Exceptions and Debugging

Brief

The article teaches how to handle errors and exceptions.

Details

In this article, you will learn how to handle errors and exceptions from the FCLite API and what each error code means. Errors and exceptions are inevitable when working with any API, and knowing how to handle them properly can improve your application's reliability, usability, and security. You will learn how to use the FCLite client object to catch and handle errors and exceptions, how to interpret the error codes and messages returned by the FCLite server, and how to implement best practices for error handling in your application. To handle errors and exceptions from the FCLite API, follow these steps:

Step 1: Create a FCLite client object with your API key using the appropriate syntax for your language.

Step 2: Use the client object to make requests to the FCLite API endpoints that you need. For example, if you want to request a list of orders, you can use the orders endpoint.

Step 3: Use a try-catch block or a similar construct to catch any errors or exceptions that may occur when making requests or parsing responses.

Step 4: Check the error code and message returned by the FCLite server to determine the cause and severity of the error or exception. The error code is a numeric value that indicates the type of error or exception, while the message is a human-readable string that provides more details.

Step 5: Handle the error or exception according to your application logic and user expectations. Depending on the error code and message, you may want to retry the request, display an error message, log the error, or take other actions.

Here are some examples of how to handle common errors and exceptions from the FCLite API:

• If you receive an error code 400 (Bad Request), it means that your request was invalid or malformed. You should check your request parameters, headers, body, and syntax for any errors or typos. You should also check the documentation for each FCLite API endpoint to see which parameters are required and what values are valid.

• If you receive an error code 401 (Unauthorized), it means that your API key was invalid or expired. You should check your API key for any errors or typos. You should also make sure that your API key has not been revoked or expired. You can generate a new API key from your FCLite account dashboard.

• If you receive an error code 403 (Forbidden), it means that you do not have permission to access the requested resource or perform the requested action. You should check your account settings and permissions for any restrictions or limitations. You should also make sure that you are using the correct account ID and offer ID for your requests.

• If you receive an error code 404 (Not Found), it means that the requested resource does not exist or has been deleted. You should check your request URL for any errors or typos. You should also make sure that the resource ID or name that you are requesting is correct and exists on the FCLite server.

• If you receive an error code 500 (Internal Server Error), it means that there was an unexpected error on the FCLite server side. You should try to repeat your request after some time. If the error persists, you should contact FCLite support for assistance.

Some tips and best practices for handling errors and exceptions from the FCLite API are:

• Use a consistent and robust error handling strategy throughout your application. You should catch and handle errors and exceptions at every point where they may occur, such as when making requests, parsing responses, processing data, or displaying results.

• Use descriptive and informative error messages for your users. You should provide clear and helpful feedback to your users when an error or exception occurs, such as what went wrong, why it happened, and what they can do to fix it or avoid it in the future.

• Use logging and monitoring tools to track and analyze errors and exceptions in your application. You should record every error or exception that occurs in your application, including the timestamp, request parameters, response data, stack trace, and user context. You should also use tools that can alert you of any errors or exceptions in real time, and provide you with insights and reports on error trends, root causes, and impacts.

• Learn and improve from error data. You should use the data collected from logging and monitoring tools to identify patterns, trends, root causes, and impacts of your errors and exceptions. You should also use the data to improve your application's quality, performance, and security, and to prevent or reduce errors and exceptions in the future.

For examples, refer to the article Execute a command.

Debugging

You can debug your code using the FCLite API. To use debugging add this code to your index.js:

Debugging Hide

typescriptjavascript
let logLevel = TraduAPI.LoggerFactory.LEVEL_DEBUG;
let logger = TraduAPI.LoggerFactory.createLogger(logLevel);
let session = TraduAPI.FXConnectLiteSessionFactory.create('RefreshAccountProfileDataSample');
session.setLogger(logger);

Level can be:

You will get the corresponding information in the console.

Conclusion:

In this article, you learned how to handle errors and exceptions from the FCLite API and what each error code means. You learned how to use the FCLite client object to catch and handle errors and exceptions, how to interpret the error codes and messages returned by the FCLite server, and how to implement best practices for error handling in your application. You also learned some examples, tips, and best practices for handling common errors and exceptions from the FCLite API. To learn more about the FCLite API and its features, you can refer to this official documentation.

back