Skip to content

EPMware REST API Guide

Welcome to the EPMware REST API Guide. This comprehensive reference provides detailed documentation for integrating with EPMware through RESTful web services, enabling automation and external system integration.

About This Guide

The EPMware REST API enables developers to programmatically interact with EPMware modules, automate processes, and integrate with external applications. This guide is designed for developers, system integrators, and administrators responsible for:

  • Integrating EPMware with external systems
  • Automating EPMware processes through API calls
  • Building custom applications that interact with EPMware
  • Managing security and user provisioning programmatically
  • Orchestrating deployment and export operations

Version Information

This guide covers EPMware REST API version 1.3, updated May 2025

Key Features

RESTful Architecture

The EPMware REST API follows RESTful principles, providing a consistent and predictable interface for all operations.

Module-Based Organization

APIs are organized by functional modules: - Task - Monitor and manage task execution - ERP - Handle ERP import operations - Deployment - Execute and monitor deployments - Export - Run exports and retrieve results - Security - Manage users and security groups

Token-Based Authentication

Secure token-based authentication ensures authorized access to API endpoints while maintaining session state.

Quick Start

New to EPMware REST API? Follow these steps to get started:

  1. Generate Authentication Token - Create an API token for your user
  2. Understand URL Structure - Learn the API endpoint patterns
  3. Make Your First Call - Execute a simple API request
  4. Handle Responses - Process success and error responses
  5. Explore Examples - Review working code samples

API Modules Overview

Module Purpose Common Use Cases
Task Task management and monitoring Get task status, retrieve logs
ERP ERP data import operations Upload files, trigger imports
Deployment Deployment execution Run deployments, get execution details
Export Data export operations Execute exports, download results
Security User and group management Create users, assign permissions

Prerequisites

Before using this guide, ensure you have:

  • Access to an EPMware environment (cloud or on-premise)
  • Administrator privileges to generate API tokens
  • Basic understanding of REST API concepts
  • Familiarity with HTTP methods (GET, POST, PUT, PATCH)
  • A tool for making API calls (curl, Postman, or programming language)

Important Security Note

Always store API tokens securely and never commit them to version control systems. Rotate tokens regularly and follow security best practices.

Making Your First API Call

Here's a simple example to get you started:

# Get task status
curl GET 'https://demo.epmwarecloud.com/service/api/task/get_status/244591' \
  -H 'authorization: Token YOUR-TOKEN-HERE'

Response: 

{
  "status": "S",
  "percentCompleted": "100",
  "message": "Task completed successfully",
  "taskId": "244591"
}

Support & Resources

Documentation Sections

Explore the complete REST API documentation:

  • Getting Started

    Authentication, URL structure, and basic concepts

    Get started

  • API Modules

    Detailed documentation for all API modules

    Explore modules

  • API Reference

    Complete endpoint reference and parameters

    View reference

  • Task Management

    Monitor and manage task execution

    Task APIs

  • ERP Integration

    Upload files and run ERP imports

    ERP APIs

  • Deployment

    Execute and monitor deployments

    Deploy APIs

  • Export Operations

    Run exports and download results

    Export APIs

  • Security Management

    Manage users and security groups via API

    Security APIs

  • Code Examples

    Working examples in multiple languages

    View examples

  • Best Practices

    Guidelines for optimal API usage

    Learn more

  • Appendices

    Additional resources and references

    Resources