Unified Compliance NextGen
  • UCF NextGen
    • On-Boarding
    • PlantUML
      • Diagrams as Code
        • Why use diagrams as Code tools?
        • Use Cases
        • Introduction to PlantUML
        • Syntax
          • Basic PlantUML Syntax
          • Sequence Diagram
            • Lifelines
            • Messages
            • ExecutionSpecification
            • Autonumber
            • Notes
            • Interactions
            • Organization
          • Use Case Diagram
            • Use Case
            • Actor
            • Associations
            • Organization
            • Notes
          • Class Diagram
            • Classes and Other Entities
            • Attributes and Methods
            • Relationships
            • Organization
            • Notes
          • Object Diagram
            • Objects
            • Relations and Associations
            • Organization
            • Notes
          • Work Breakdown Structure Diagram
            • OrgMode Syntax
            • Arithmetic Notation
            • Styling
          • Activity Diagram
            • Actions and Other Objects
            • Arrows
            • Conditionals
            • Loops
            • Forks, Splits, and Merges
            • Notes
          • Text Formatting
          • Skin Parameters
    • Control Workspace
      • My Frameworks
        • Authority Document Details
        • Common Control Details
      • List Manager
      • Compare
      • Exports
    • UCF Catalog
    • Profile
    • Administration
      • Account Settings
        • General
        • Team
        • Organization
        • Industry
        • Groups
        • Initiatives
      • API Manager
      • Billing
    • API Gateway
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. UCF NextGen

API Gateway

Unified Compliance REST-based APIs

PreviousBilling

Last updated 3 days ago

Was this helpful?

The UCF NextGen application is also an API Gateway, ie. a software platform where your organization can interact with the Unified Compliance library of data. API developers can make API calls to the gateway to retrieve and publish data.

The gateway supports RESTful APIs that:

  • Are HTTP-based

  • Enable stateless client-server communication

  • Implement standard HTTP methods such as GET, POST, and PATCH

  • Utilize an API Key for authentication

Visit the API Manager page and select the Keys tab to generate API Key(s) for your account. Then when calling the APIs, set an authorization header named "x-api-key" with the value of your API Key.

A valid subscription plan is required to make API calls.

Refer to the UCF NextGen API documentation here for more details:

https://uc4apidocs.unifiedcompliance.com/