Preface

The Simphony Data Import/Export API is a JSON-based, REST web service that helps you to create and submit data import and export job requests. The web service can be used to integrate with third-party applications and programmatically export menu items from one system and import them to another, among many other features, thereby saving time for administrators and managers. Furthermore, you can efficiently create new software applications by leveraging the web service capabilities of the Import/Export API. The web service allows you to:

  • Import and export data programmatically

  • Export data automatically using the scheduler

  • Review the status of completed import and export jobs

Purpose

This guide describes how to use the programming interfaces of the Import/Export web service in a secure manner. It introduces the REST application programming interface (API), reviews security threats and mitigations that are built into the web service, and reviews secure coding principles.

Audience

This guide is intended for users who are familiar with web services, JSON, and common programming language constructs.

Customer Support

To contact Oracle Customer Support, access the Customer Support Portal at: https://iccp.custhelp.com.

When contacting Customer Support, please provide the following:

  • Product version and program/module name

  • Functional and technical description of the problem (include business impact)

  • Detailed step-by-step instructions to re-create

  • Exact error message received and any associated log files

  • Screenshots of each step you take

Documentation

Oracle Food and Beverage product documentation is available on the Oracle Help Center at http://docs.oracle.com/en/industries/food-beverage/.

The following references provide additional background information that are needed for secure usage of the Import/Export web service.

Revision History

Date Description of Change
September 2025 Initial publication.