🔃Supported API Request Types

Introduction

This document details the types of API requests that are supported by the scriptless automation framework. These requests can be used to interact with web services without the need to write scripts, streamlining the testing and interaction with APIs.

Standard API Requests

The framework supports the following standard HTTP methods, which are used for CRUD (Create, Read, Update, Delete) operations:

• GET: Retrieves data from a specified resource.

• POST: Submits data to a specified resource to process.

• PUT: Updates a specified resource with provided data.

• DELETE: Deletes a specified resource.

Relaxed API Requests

In addition to the standard methods, the framework provides "relaxed" versions of each method. These are particularly useful when dealing with self-signed SSL certificates or when SSL certificate validation is not a concern during the testing phase:

• RELAX_GET: Similar to GET, but with SSL certificate validation disabled. This is useful when the API is secured with HTTPS but has an invalid or self-signed certificate that a client would ordinarily reject.

• RELAX_POST: Functions like a POST request with SSL certificate validation turned off. This is used when posting data to a secure API that has an invalid or self-signed certificate.

• RELAX_PUT: Works as a PUT request while bypassing SSL certificate validation. This allows updating resources on a secure API without validating its SSL certificate.

• RELAX_DELETE: Operates as a DELETE request without enforcing SSL certificate validation. This is used for deleting resources on a secure API while ignoring SSL certificate issues.

Usage Considerations

While the relaxed versions of the HTTP methods provide convenience during development or testing environments, they should be used with caution. Disabling SSL validation in production environments can expose the application to security vulnerabilities such as man-in-the-middle attacks.

Conclusion

The scriptless automation framework supports a variety of API request types to accommodate different testing scenarios, including scenarios where SSL certificate validation needs to be bypassed. Users should select the appropriate request type based on their testing requirements and the environment in which they are working.

For projects that require additional support beyond the provided request types or for assistance in implementing these methods securely, please do not hesitate to reach out for support through our contact page. Additionally, if there are any issues or feature requests, we encourage users to report them on our Git repository issue tracker with template. Our team is committed to providing timely and helpful responses to ensure your testing and automation needs are met effectively.