WebAPI User Guide

Get started with our WebAPI Module

In this guide

• WebAPI Integration Setup Guide

  ---

  Learn how to create and design a WebAPI integration to accept inbound REST requests.

• General Setup for WebAPI

  ---

  Configure security, endpoints and user properties for IMan's WebAPI.

• User Property & Request Relationship

  ---

  How WebAPI user properties, property sets and endpoints relate, and how they are resolved when a request arrives.

• OpenAPI Endpoint Description

  ---

  The OpenAPI description endpoint IMan generates, and how request and response schemas are derived from the integration definitions.

• Monitoring WebAPI with Grafana

  ---

  Monitor IMan WebAPI endpoints in Grafana, using the request time and requests-per-minute metrics IMan publishes.

• Installation & Setup of Grafana

  ---

  Install and configure Prometheus and Grafana on Windows to collect and visualise IMan WebAPI metrics.

• Request Logging

  ---

  How IMan logs each WebAPI request and response to the database, and how correlation ids tie them together.

• Sample Integrations

  ---

  Learn how to use the WebAPI module with samples for Sage200, Sage300 and SageX3.

Document Purpose

This guide covers:

• Create WebAPI Integrations
• Administration of WebAPI
• Learn how to Monitor Requests to the WebAPI

New to IMan?

FAQs