1 Introduction

Oracle Retail Brand Compliance Management Cloud Service (Brand Compliance) is an application designed to meet all aspects of sourcing, developing, and protecting retailer brands. The application provides solutions for product development, compliance, quality, and traceability. It is designed specifically for retail, food service, and manufacturing businesses to develop and protect their brands, manage their suppliers, and ensure full end-to-end product lifecycle management.

Brand Compliance includes a number of exposed Application Programming Interfaces (APIs) that can be called by external systems. This document details all of the exposed APIs and the information required in order to access them.

An API is a way of exchanging data between computer systems. The owners of an external system can interact with Brand Compliance by developing the necessary functionality to trigger the web service submissions, and handle the returned messages from Brand Compliance.

In order to access Brand Compliance using its APIs, the portal owner must grant the external system access. This is achieved by creating an External Systems account in the Admin area and assigning the unique access credentials in the form of a login ID and password.

Note:

The terminology used for Scorecard and Project has changed. Scorecard has been renamed to Assessments. Projects has been renamed to Process. The associated API names and endpoints/functions are not changed. For Assessments, see the ScorecardRestAPI. For Processes, see the ProjectRestAPI.

Contents of this Guide

This implementation guide addresses the following topics:

• API Overview and Architecture: Overview of the Brand Compliance APIs and architecture used.

• APIs Available in Brand Compliance: Summary of the APIs, including the release in which the API is available and the type of API.

• RESTful APIs: Details of the available APIs that are based on the RESTful architecture.

• SOAP APIs: Details of the available APIs that are based on the SOAP architecture.

• Appendix: Secure Development Guide: Description of some best practices for web service use.

• Appendix: Using the Data Privacy API: Additional detail on using the Data Privacy API, including examples.

• Appendix: Using the Report Attachment API: Details on using the Report Attachment API.

Key Features of Brand Compliance Management Cloud Service

The application is composed of the following modules:

• Library enables the issue, receipt, and acceptance of policies, guidelines, and key working documents.

• Product supports the development of products and production specifications.

• Process supports the development of process briefs, plans, and workflow management.

• Supplier enables the identification, selection, and approval of suppliers.