Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue

Rest Testing Tool

...

  1. Log in to iHub site

  2. Navigate to Support Menu and Click Rest Testing Tool

Application Programming Interface (API) in WMS

An Application Programming Interface (API) is a set of tools and protocols that allows different software applications to communicate with each other. APIs enable the integration of various systems and services in WMS.

iHub uses REST API architecture. This means it follows a set of rules for creating web services that allow different applications to interact over the internet using standard HTTP protocols.

  1. Swagger UI Page will open on new tab and will show list of REST API services (Load and Retrieve Services) available to connect to the Integration Hub

Make sure to use the correct Token (Swagger UI header) if multiple Token has been created.

See https://seko.atlassian.net/wiki/spaces/SMAN/pages/2933030943/iHub+-+Settings#API-Credentials

...

  1. Select service and API call type (POST/GET)

  2. Select "Parameter content type" and “Response content type” (xml, json format).

  3. Enter Parameter Value on the Request Box (Click the “Example Value” box to copy it into the "Request" box to easily edit values)

  4. Click API call type button (POST/GET) to submit request

Click “Try it Out” button to submit a test message

  1. Check Activity log to monitor status if Success or Fail and to view details of request

Post.pngImage AddedGET.pngImage Added

Rest api activity.pngImage Added

Types of services

  1. Submitting Data: This is done through the Load services (POST). When you need to send data to the hub, you use these services.

  2. Querying Data: This is handled by the Retrieve services (GET). When you need to get data from the hub, you use these services.Pushing Data: Data can also be automatically sent to a client’s URL endpoint using the Push services. This means the hub can send data to a specified location without needing a manual request.

  3. Log in to iHub site

  4. Navigate to Support Menu and Click Rest Testing Tool

  5. Swagger Page will open on new tab and show list of Load and Retrieve Services