FAQs
Please check out Frequently Asked Questions.
What is an API service in Qyrus?
An API service is a software component that provides a standardized way for different software applications to communicate and exchange data over the internet. It exposes a set of endpoints that allow other applications to request and receive specific information or perform actions.
What types of API services are there?
There are 3 types of API services:
RESTful APIs: Based on Representational State Transfer principles, using HTTP methods (GET, POST, PUT, DELETE) for communication.
SOAP APIs: Using the Simple Object Access Protocol for communication, often with XML-based payloads.
GraphQL APIs: Allowing clients to request specific data and shape the response according to their needs
How do API services work?
API services work by exposing endpoints (URLs) that correspond to specific functionalities. Clients (other applications) send requests to these endpoints using HTTP methods, and the service processes the requests, performs actions, and sends back responses, often in JSON or XML format.
What is the difference between an API and an API service?
An API (Application Programming Interface) is a broader concept that defines how different software components should interact. An API service specifically refers to a service that exposes endpoints over the internet to provide specific functionalities for clients to consume.
How is data exchanged in API services?
Data is exchanged using requests and responses. Clients send requests to the API service's endpoints, including necessary data in the request body or as parameters. The service processes the request, performs the required actions, and sends back a response containing the requested data or the outcome of the operation.
How many frameworks API Service Contains in Qyrus?
API Service containing 3 types of Frameworks.
Functional Testing.
Performance Testing.
API Process.
What does Functional Testing do?
It will check the Functionality of the API and give the result as a pass or fail.
What does API Process do?
It is the process of Importing the APIs, Managing the APIs and chaining the APIs based on the given Inputs. Users can pass the parametrization of one API to another API and get the response.
What is Certificate in Qyrus API and how will it work?
A certificate in Qyrus API is used for securing communication between the Qyrus client and a server during API requests. Certificates are an integral part of establishing secure connections over HTTPS (Hypertext Transfer Protocol Secure) and are used to authenticate the server's identity and encrypt the data being transmitted.
When you send API requests from Qyrus API to a server using HTTPS, the server presents its digital certificate to prove its identity. Qyrus API Service can verify the authenticity of the certificate by checking whether it's issued by a trusted Certificate Authority (CA) and matches the server's domain.
What is Create Environment in Qyrus API?
Creating environments in Qyrus API to provides flexibility and convenience in managing various configurations. It helps you maintain consistency across requests and makes it easier to switch between different setups when testing and interacting with your APIs.This is particularly useful when you need to test your API against different environments (e.g., Local, Staging, Production) or when you're working with multiple APIs that share common variables.
What is Global Variable in Qyrus API ?
Global variables in Qyrus API allow you to define variables that can be used across different requests, scripts, and test assertions within your API. Global variables are especially useful when you need to reuse data across multiple API requests or when you want to maintain a consistent configuration throughout your testing process.
What is Prerequisite API?
A prerequisite API is an API that needs to be accessed, invoked, or completed successfully before another API can be used or interacted with.
What is Data Handler in Project Setup?
A data handler is a term that generally used to specifies dynamic variable.
What is Integration in Project Setup?
Integration in the Project Setup of the Qyrus API facilitates connections with Jira integrations. Users are required to enter their Jira configuration details, including their username and API Token, to establish a connection with Jira. Once the configuration is provided, the script allows you to seamlessly log bugs directly to Jira by clicking on a button.
What does Database Assertion do?
Database Assertion is primarily used to establish connections with databases. It is also referred to as a Meta connector, enabling the establishment of connections for various databases including "MYSQL", "Oracle SQL", "Snowflake", "Netezza", "DynamoDB", "Lambda Function", "DB2" and "RedShift."
What is Preview option in API Process?
The purpose of offering a Preview API is to gather insights from developers, identify any issues or areas for improvement, and refine the API before it's widely available for production use. It's a way to ensure that the API meets the needs of its users and provides a positive experience.
What is "Move" and "Copy and Move" in Test Script Page?
The term "Move" option refers to relocating an API from one suite to another suite entirely. In contrast, "Copy and Move" entails replicating the API to another suite, essentially creating a duplicate in the new location.
What is Assertion on Header?
An assertion on a header, in the context of API testing, refers to a validation check performed on the headers of an HTTP response. HTTP headers are metadata included in the response sent by a server when an API request is made. Assertions on headers are used to verify that the headers of the response meet certain expected criteria. These assertions play a crucial role in ensuring the correctness and integrity of the API's behavior. In a dropdown filed you will get multiple options to perform the assertion on headers (eg : Status Code, accept, accept_encoding, accept_language, accept_dateandtime etc).
What is JSON PATH EXTRACTOR in Qyrus API?
A JSON Path Extractor is a feature used in Qyrus API Service to extract specific data from JSON (JavaScript Object Notation) responses. JSON Path is a query language that allows you to navigate through JSON structures and select elements, values, or objects based on certain criteria. The JSON Path Extractor helps you retrieve and utilize specific pieces of data from JSON documents, which is particularly useful when working with APIs that return JSON data.
What is XPATH EXTRACTOR in Qyrus API?
An XPath Extractor is a feature used in Qyrus API Service to extract specific data from XML using XPath expressions. XPath (XML Path Language) is a query language that allows you to navigate through the hierarchical structure of XML and elect elements, attributes, or values based on certain criteria. The XPath Extractor helps you locate and utilize specific pieces of data from these documents.
What is Schema Validation?
Schema validation is a process used to verify whether data or documents adhere to a predefined structure or schema. A schema defines the expected format, rules, and constraints that data must follow. Schema validation is a fundamental practice in Qyrus API Service, ensuring that data remains accurate, compliant, and reliable according to predefined specifications.
What is Parametrization in Qyrus API?
Parametrization option in Qyrus APIs refers to the practice of using variables or parameters to make API requests more dynamic and versatile. Instead of hardcoding specific values directly into the requests, you use placeholders that can be replaced with actual values when the requests are made. Parametrization is a powerful technique that enhances the flexibility, reusability, and maintainability of your API tests and interactions.
What is URL Encode Enabled in Create Script Page?
The "URL Encode Enabled" option is available within the create script page. This option allows users to include a context path with special characters such as "$", "&", "*", and more. The purpose of this option is to ensure proper URL encoding of the context path, facilitating accurate and secure transmission of data in API requests.
What is Timeout option in Create Script Page?
In the context of APIs, a timeout refers to the maximum duration an API request is allowed to take before it's considered unsuccessful or terminated.
What are all the verbs/Methods Qyrus API supports?
Qyrus API supports “Get”, “Post”, “Put”, “Delete” and “Patch” methods.
What is Authorization and how many types of Qyrus API Support?
Authorization in the context of APIs refers to the process of granting or denying access to specific resources or functionalities within an API based on the identity and permissions of the requester. It ensures that only authorized users or applications are allowed to perform certain actions or retrieve specific data. Authorization is a crucial aspect of API security and access control.
Qyrus API Supports 3 ways to authorize the data.
Basic Auth
O Auth2.0
None (Without authorization)
What are the actions in Qyrus API Report Page?
The Qyrus API Report page includes the following options: "User Id," "Send Mails," "Download Report," "Retry," "Delete Report," and "Create Ticket."
What types of files are supported by Qyrus API to Import and Upload the API?
Qyrus supports importing APIs through Swagger files, WSDL files, Postman files, and URLs.
What is manage API option in API Process?
The "Manage API" options in the API process are utilized after importing the API. They enable users to make modifications to the API following the import. Depending on the requirements, users can perform assertions before proceeding with changing process.
What is a new experience toggle in API Process create flow page?
The "New Experience" toggle will allow users to access a new canvas page where they can easily drag and drop APIs. This feature will enable users to connect different nodes of APIs by simply dragging a connection line from one node to another. Furthermore, users can conveniently update the connections by clicking on the wire lines.
What does timer icon do at the AI Process create flow page?
It is primarily utilized to introduce a specific time delay before the execution of the second API. This function should be applied within the connections.
How to execute an API process? What are the methods of execution?
To execute an API process, follow these steps: Import an API, manage the API settings, establish connections between APIs, and then click on "Execute."
API processes offer two methods of execution:
Execute your API functionally.
Execute your API for performance testing.