G4™ Hub API

The G4 Hub API provides a comprehensive interface for managing templates, environments, integration metadata, and automation workflows within the G4™ Engine. This repository contains the source code and configuration necessary to deploy and interact with the API service.

---

Table of Contents

• Development License
• Features
• Getting Started
  • Prerequisites
  • Installation
    • Option 1: Run with Docker
    • Option 2: Run Standalone
• Usage
  • Invoking Automation Workflows
• API Documentation
• Configuration
• Contributing
• License
• Support
• Acknowledgements

---

Development License

⚠️ Important

This token expires 90 days after the latest release date. Please return here to update your token when it expires.

The unlimited version of the G4™ Hub API is available for personal or an open source non-profit use, provided it is not deployed in enterprise, governmental, or military environments. To enable full functionality, use the license token provided below. When invoking automation workflows, include this token in the token field under the authentication property.

rTIlEC3IPr/GYlpGp7CLvnKUJOVrkQ1EqHwd875LZgRn712dg1cnZLAWblDr6f/0Jc5LzyelEr5B7O4O3nZtKumTv4lXST78oM/hW8tCE40q97ZGjGX3oCVWjzj2t7jp9Jh9O0ynNm+WvJfmlQVPXdJLHIjetaIJJWfNZFKgbAFLPqKMIauUIaa2ytMq7lgjVASwKeZ4FRG6CyyfrcLmw6u886UmlpK01Cqa1qy7HQuaiTwXdyFnrY20NjU01rsCm0RRKti/76w9PKK6Cy7mgAkI9JkZQaCS3z9CdKUezu86FNYwkBdG1cnea3lf/FeO5xGa7SH9hNqeyMQeOOOAmwTiM6NeTd15WvjEXFEBsfA=

---

Features

• Template Management: Add, update, retrieve, and delete templates efficiently.
• Environment Operations: Create, modify, and remove environments and their associated parameters.
• Automation Invocation: Invoke and initialize automation workflows seamlessly.
• Integration Metadata Access: Retrieve plugin manifests, caches, and synchronize integration data.

---

Getting Started

Prerequisites

• .NET 8.0 SDK or higher: Required if running the service standalone.
• Docker: Required if running the service using Docker (version 20.10 or higher).
• API Client: Use tools like curl, Postman, or any HTTP client library to interact with the API.

Installation

Option 1: Run with Docker

ℹ️ Important

You can run the service using Docker directly from docker hub by running the following command:

docker run -d -p 9944:9944 g4api/g4-hub:latest

1. Clone the Repository

   git clone https://github.com/g4-api/g4-services.git
   cd g4-services-hub

2. Build the Docker Image

   docker build -f ./docker/G4.Services.Hub.Dockerfile -t g4-services-hub .

3. Run the Docker Container

   docker run -d -p 9944:9944 --name g4-services-hub g4-services-hub

4. Access the API

   • The API will be accessible at http://localhost:9944/swagger.

Option 2: Run Standalone

1. Install .NET SDK

   • Download and install the .NET 8.0 SDK suitable for your operating system (Windows, Linux, or macOS).

2. Download the Latest Release

   • Go to the Releases page.
   • Download the latest production version ZIP file.

3. Extract the Package

   • Extract the contents of the ZIP file to your desired location.

4. Run the Service

   dotnet G4.Services.Hub.dll

5. Access the API

   • The API will be accessible at http://localhost:9944/swagger.

---

Usage

Invoking Automation Workflows

The API allows you to invoke automation sessions using the /automation/invoke endpoint. Below is an example of how to structure the request body for invoking an automation workflow.

Endpoint

POST /api/v4/g4/automation/invoke

Example Request Body

{
    "authentication": {
        "token": "CTJEvbiw0QlqBN5GeXI9bOedyPcxUvBlKFFo3pg1VIxyF30Lt/QN1O8P4wxcj7AEhLexYhzo1H+Z9N17gg1IOaV1LwQ7bNyFnlpI6GmY7jwYV0Jc0at2pcIuU9VOIwJs5eVWktfgsSxSIP4/p1cqGec19ngefShnWnorMdewDn62USCYsxFOxl7b/reTEzqSxWHL8iaFOFJhOkviiarnFhMfD0jAVreMyiIlyOL7nar1fAQl1zCR+NQpfGecT7L6Y5WJMB0yg+oXE7xyZvYn54Acr0p03l8wwhSvK+5mw9H3anbrwvwbEDFpu/aRbMfQ6gYrkOf4SHvZhAl1igDtNFXKtvie0NQNtWiPQ0OTnJ0="
    },
    "driverParameters": {
        "driver": "MicrosoftEdgeDriver",
        "driverBinaries": "{{DriverBinaries}}",
        "capabilities": {
            "alwaysMatch": {
                "browserName": "MicrosoftEdge"
            },
            "firstMatch": [
                {}
            ]
        }
    },
    "stages": [
        {
            "name": "Sample Automation Flow",
            "description": "Main stage for invoking Sample Automation Flow.",
            "jobs": [
                {
                    "reference": {
                        "name": "Sample Job",
                        "description": "Sample Job."
                    },
                    "rules": [
                        {
                            "$type": "Action",
                            "pluginName": "GoToUrl",
                            "argument": "about:blank",
                            "regularExpression": "(?s).*"
                        },
                        {
                            "$type": "Action",
                            "pluginName": "WriteLog",
                            "argument": "The first 8 alphanumeric characters of the GUID are {{$New-Guid --Pattern:^\\w{8}}}"
                        },
                        {
                            "$type": "Action",
                            "pluginName": "CloseBrowser"
                        }
                    ],
                    "stopOnError": false
                }
            ]
        }
    ]
}

Note: Ensure that you replace placeholders like <your-username>, {{ApiUser}}, and {{DriverBinaries}} with actual values relevant to your setup.

Description

• authentication: Contains credentials for API access. Replace {{ApiUser}} with your API username/key/credentials.
• driverParameters: Configures the web driver for the automation session.
  • driver: Specifies the driver to use (e.g., MicrosoftEdgeDriver).
  • driverBinaries: Can be a physical location of the WebDriver binaries or a Selenium Grid endpoint. Replace {{DriverBinaries}} with the appropriate file path or grid URL.
  • capabilities: Defines the desired capabilities for the driver session.
• stages: Defines the stages of the automation process.
  • name: Name of the stage.
  • description: A brief description of the stage.
  • jobs: A list of jobs to execute within the stage.
    • reference: Metadata about the job.
      • name: Name of the job.
      • description: A brief description of the job's purpose.
    • rules: A sequence of actions to perform.
      • $type: The type of the rule (e.g., Action).
      • pluginName: The plugin to invoke.
      • argument: Arguments to pass to the plugin.
      • regularExpression: (Optional) A regex pattern for matching.
    • stopOnError: Indicates whether to halt the job if an error occurs.

Example Usage with curl

Save the example request body to a file named request-body.json and execute the following command:

curl -X POST http://localhost:9944/api/v4/g4/automation/invoke \
     -H "Content-Type: application/json" \
     -d @request-body.json

---

API Documentation

Detailed API documentation is available via Swagger UI when the service is running. Access it at:

http://localhost:9944/swagger/index.html

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of the repository page.

2. Create a Feature Branch:

   git checkout -b feature/YourFeatureName

3. Commit Your Changes:

   git commit -am "Add new feature"

4. Push to Your Fork:

   git push origin feature/YourFeatureName

5. Create a Pull Request: Open a pull request against the main branch of this repository.

---

License

This project is licensed under the Apache v2.0.

---

Support

If you encounter any issues or have questions, please open an issue in the repository or contact the maintainers.