Introduction to Ghost Inspector

Ghost Inspector is an end-to-end UI testing tool that allows you to automate your website or web application’s testing with ease. Its robust APIs enable you to integrate and scale your testing effortlessly. In this guide, we dive deep into various Ghost Inspector APIs with practical examples and an application to demonstrate real-world usage.

Getting Started with Ghost Inspector API

The first step in using Ghost Inspector API is to authenticate your requests. You can authenticate using an API key that you can get from your Ghost Inspector account.

1. Authentication

  curl -X GET "https://api.ghostinspector.com/v1/tests/?apiKey=YOUR_API_KEY"

2. Running a Test

To trigger a test in Ghost Inspector, use the following endpoint.

  curl -X POST "https://api.ghostinspector.com/v1/tests/TEST_ID/execute/?apiKey=YOUR_API_KEY"

3. Retrieving Test Results

After executing a test, you might want to retrieve the results. Use this endpoint to get the test results.

  curl -X GET "https://api.ghostinspector.com/v1/test-results/RESULT_ID/?apiKey=YOUR_API_KEY"

4. Fetching All Suites

To get a list of all test suites in your account, use the following endpoint:

  curl -X GET "https://api.ghostinspector.com/v1/suites/?apiKey=YOUR_API_KEY"

5. Running a Suite of Tests

Trigger all tests in a suite with a single API call:

  curl -X POST "https://api.ghostinspector.com/v1/suites/SUITE_ID/execute/?apiKey=YOUR_API_KEY"

6. Handling Organizations

You can also manage organizations that your account has access to:

  curl -X GET "https://api.ghostinspector.com/v1/organizations/?apiKey=YOUR_API_KEY"

Example Application Using Ghost Inspector APIs

Here is a simple Node.js application showcasing how to use the Ghost Inspector APIs:

  const axios = require('axios');
  const apiKey = 'YOUR_API_KEY';

  async function runTest(testId) {
    try {
      const response = await axios.post(\`https://api.ghostinspector.com/v1/tests/\${testId}/execute/?apiKey=\${apiKey}\`);
      console.log(response.data);
    } catch (error) {
      console.error('Error running test:', error);
    }
  }

  async function getTestResults(resultId) {
    try {
      const response = await axios.get(\`https://api.ghostinspector.com/v1/test-results/\${resultId}/?apiKey=\${apiKey}\`);
      console.log(response.data);
    } catch (error) {
      console.error('Error retrieving test results:', error);
    }
  }

  // Run and fetch results for demonstration
  const testId = 'TEST_ID';
  const resultId = 'RESULT_ID';
  runTest(testId).then(() => {
    getTestResults(resultId);
  });

In this example, we demonstrated how to run tests and fetch test results using Ghost Inspector’s API in a Node.js application.

Using these APIs effectively can significantly enhance your automated testing workflow, saving you time and ensuring a higher quality product.

Hash: 1a7683eac0f9a6ae8e8959e78e12512aceedc325743707956f50405766885c48