API Overview - HGT EAM WebServices

Introduction

The HGT EAM WebServices API is a RESTful gateway that provides simplified and optimized access to INFOR EAM (Enterprise Asset Management) grid data. The API implements an intelligent SQLite-based caching system to ensure fast and reliable responses.

Base URL

All API requests should be made to:

https://your-domain.com/api

Replace your-domain.com with your actual API server domain.

Endpoint Categories

The API organizes endpoints into four main categories:

Provision (Abastecimiento)

Procurement and supply chain data from EAM.

GET /api/provisions/contracts - General contract data
GET /api/provisions/purchase/order/audit - Purchase order audit
GET /api/provisions/view/purchase/order - Finance view of purchase orders (OC)
GET /api/provisions/view/purchase/request - Finance view of purchase requests (SC)

Accounting (Contabilidad)

Accounting and financial transaction data.

GET /api/accounting/transactions - Transaction grid data
GET /api/accounting/kardex - Kardex inventory report

Accounts Payable (Cuentas por Pagar)

Accounts payable and invoice data.

GET /api/accounts-payable/invoice/vouchers/ecuador - Invoice vouchers for Ecuador
GET /api/accounts-payable/billing/finance/view - Finance view of billing
GET /api/accounts-payable/billing/finance/order-purchase - Finance view of purchase orders

Management Control (Control de Gestión)

Management control and cost analysis data.

GET /api/management-control/provisions - Provisions grid data
GET /api/management-control/maintenance/costs - Maintenance cost information

Request Parameters

All grid endpoints accept the following query parameters:

TypeFilter

Defines the time period filter for data retrieval.

TypeFilter

integer

required

Filter type for date range:

1 - PreviousDay: Previous day’s data
2 - PreviousMonth: Previous month’s data
3 - CurrentMonth: Current month’s data
4 - LastYear: Last year’s data
5 - FullMonthByYear: Specific month and year
6 - Custom: Custom date range
7 - AllRecords: All available records

Month

integer

Specific month to query (1-12). Required when TypeFilter=5.

Year

integer

Specific year to query. Required when TypeFilter=5. Valid values from previous year onwards.

Page

integer

default:"1"

Page number for pagination. Starts at 1.

PagSize

integer

Number of records to return per page. If not specified, uses the default configured page size.

Response Format

All successful grid responses return a standardized JSON structure:

{
  "currentPage": 1,
  "gridName": "Vista finanzas OC",
  "gridId": 12345,
  "totalRecordsReturned": 50,
  "totalPages": 10,
  "totalRecords": 500,
  "dataRecord": {
    "fields": [
      {
        "id": 1,
        "label": "Order Number",
        "name": "orderNumber",
        "order": 1,
        "type": "string",
        "visible": true,
        "width": 150
      }
    ],
    "rows": [
      {
        "orderNumber": "PO-2026-001",
        "amount": 15000.50,
        "status": "Approved"
      }
    ]
  }
}

Response Fields

currentPage - Current page number in the result set
gridName - Human-readable name of the grid
gridId - Unique identifier for the grid configuration
totalRecordsReturned - Number of records in current page
totalPages - Total number of pages available
totalRecords - Total number of records matching the query
dataRecord.fields - Array of field metadata describing the columns
dataRecord.rows - Array of data rows with actual values

Pagination

The API uses offset-based pagination:

Use the Page parameter to specify which page to retrieve (starting at 1)
Use the PagSize parameter to control the number of records per page
The response includes totalPages and totalRecords to help with pagination UI

Example: Paginated Request

curl -X GET "https://your-domain.com/api/provisions/contracts?TypeFilter=3&Page=2&PagSize=25" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ="

Caching System

The API implements an intelligent SQLite-based caching system:

First Request: Data is fetched from INFOR EAM SOAP services and cached
Subsequent Requests: Data is served from the cache for faster response times
Cache Duration: 15 minutes (900 seconds) response cache on endpoints
Persistence: Cache persists between application restarts

Benefits

Ultra-fast responses for previously queried data
Reduced load on INFOR EAM servers
Efficient pagination without re-querying the service

Rate Limiting

The API implements rate limiting to protect service availability:

Limit: 60 requests per minute
Scope: Per authenticated user or IP address (for anonymous requests)
Response: HTTP 429 (Too Many Requests) when limit exceeded

Rate Limit Headers

When rate limited, the response includes:

{
  "statusCode": 429,
  "message": "Too many requests",
  "retryAfterSeconds": 45
}

The Retry-After header indicates when you can retry the request.

Error Responses

The API uses standard HTTP status codes and returns structured error responses:

Error Response Format

{
  "statusCode": 400,
  "message": "Invalid request parameters",
  "correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Common Status Codes

200

Request successful, data returned

400

Bad Request

Invalid request parameters or malformed request

401

Unauthorized

Authentication failed or missing credentials

404

Not Found

Requested resource not found

408

Request Timeout

Request to EAM service timed out

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Unexpected server error occurred

501

Not Implemented

Requested operation not supported

Correlation IDs

All error responses include a correlationId that can be used for troubleshooting and log correlation. Provide this ID when contacting support.

Interactive Documentation

The API provides interactive documentation powered by Scalar:

https://your-domain.com/scalar/v1

The interactive documentation allows you to:

Browse all available endpoints
View detailed parameter descriptions
Test endpoints directly from the browser
See request and response examples
Authenticate and make live API calls

OpenAPI Specification

The OpenAPI specification is available at:

https://your-domain.com/openapi/v1.json

You can use this specification with tools like Postman, Swagger UI, or any OpenAPI-compatible client.

Example: Complete Request Flow

Here’s a complete example of fetching purchase order data:

# 1. Encode credentials (username:password)
echo -n "myuser:mypassword" | base64
# Output: bXl1c2VyOm15cGFzc3dvcmQ=

# 2. Make authenticated request
curl -X GET "https://your-domain.com/api/provisions/view/purchase/order?TypeFilter=3&Page=1&PagSize=50" \
  -H "Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ=" \
  -H "Accept: application/json"

# 3. Response includes paginated data
# {
#   "currentPage": 1,
#   "totalPages": 5,
#   "totalRecords": 234,
#   ...
# }

Next Steps

Authentication

Learn how to authenticate API requests

Provision Endpoints

Explore procurement and supply endpoints

Accounting Endpoints

Access accounting and transaction data

Request Models

Understand request parameters and models

Overview

Provision

Accounting

Accounts Payable

Management Control

Models

​Introduction

​Base URL

​Endpoint Categories

​Provision (Abastecimiento)

​Accounting (Contabilidad)

​Accounts Payable (Cuentas por Pagar)

​Management Control (Control de Gestión)

​Request Parameters

​TypeFilter

​Month

​Year

​Page

​PagSize

​Response Format

​Response Fields

​Pagination

​Example: Paginated Request

​Caching System

​Benefits

​Rate Limiting

​Rate Limit Headers

​Error Responses

​Error Response Format

​Common Status Codes

​Correlation IDs

​Interactive Documentation

​OpenAPI Specification

​Example: Complete Request Flow

​Next Steps

Authentication

Provision Endpoints

Accounting Endpoints

Request Models

Build docs developers (and LLMs) love

Introduction

Base URL

Endpoint Categories

Provision (Abastecimiento)

Accounting (Contabilidad)

Accounts Payable (Cuentas por Pagar)

Management Control (Control de Gestión)

Request Parameters

TypeFilter

Month

Year

Page

PagSize

Response Format

Response Fields

Pagination

Example: Paginated Request

Caching System

Benefits

Rate Limiting

Rate Limit Headers

Error Responses

Error Response Format

Common Status Codes

Correlation IDs

Interactive Documentation

OpenAPI Specification

Example: Complete Request Flow

Next Steps