GRAX API Connector Demo App Documentation

This documentation provides a detailed guide to using the GRAX API Connector Demo App, including the setup process and how to interact with the pre-configured API examples.

Overview

The GRAX API Connector Demo is a tool designed to help users integrate with the GRAX API, test common endpoints, and validate connectivity to GRAX services.

Features

1. API Configuration:
   • Set up and configure API connection details, including authentication.
   • Customize API settings for your GRAX instance.
2. Pre-configured API Examples:
   • Execute three sample API requests:
     • Get Auto Backup Health: Returns the health status of auto-backups.
     • Get Object: Retrieves the label and name of a specified object.
     • Get Objects: Provides a list of object labels and names.
     • Get Records: Provides a list of records.
3. Real-time Response:
   • View and validate API responses directly in the interface.

App pages

1. Dashboard Page

The main interface for testing pre-configured GRAX APIs.

• Pre-configured APIs:
  1. Get Auto Backup Health: Fetches the health status of the auto-backup feature.
  2. Get Object: Fetches the label and name of a specified object.
  3. Get Objects: Returns a list of object labels and names available in the database.
  4. Get Records: Returns a list of records.
• Execution Steps:
  1. Select one of the pre-configured APIs.
  2. Click Send Request to execute.
  3. View the API response in the Response Panel.

2. Configurations Page

This page is where you set up the connection to your GRAX API.

• Inputs Required:
  • GRAX API URL: Example: https://your-grax-url.com.
  • API Token:
    • Generate the token from your GRAX instance:
      1. Navigate to https://your-grax-url.com/web/settings.
      2. Click on “API Token” and then “New Token +”.
• Actions:
  • Save the updated configuration.
  • Validate your API URL and Token.

Setup Instructions

1. Configure API Settings:
   • Navigate to the Configurations Page.
   • Input the following values:
     • GRAX API URL
     • API Token (generated from GRAX application settings).
   • Save the configuration.
2. Update Service Center:
   • Update the GRAX API URL in Service Center:
     • Go to Service Center > “Grax_API_Connector” Module > Integrations Tab.
     • Update the URL for the GRAXAPI Consumed REST API.
3. Use the Dashboard:
   • Select a pre-configured API from the list.
   • Click Send Request to execute.
   • Review the response for validation.

How It Works

1. The Configuration Page captures the API URL and Token to establish a connection with GRAX services.
2. The Dashboard Page provides examples to test API endpoints and view their responses directly.
3. Users can customize and adapt the configuration and queries for their specific use cases.

Troubleshooting

1. Invalid API Token:
   • Ensure the token was generated correctly from the GRAX application.
2. API Connection Issues:
   • Verify that the GRAX API URL is correct and accessible.
3. Unexpected Responses:
   • Confirm the selected API matches the desired functionality.
   • Double-check the configuration values on the Configurations Page.