Integration

Our Quality Management Platform supports seamless integration with a variety of third-party software systems. This document provides guidelines on how to establish and manage integrations using two primary methods:

  1. Connecting via Existing Import/Export Platform API using Bearer Tokens
  2. Using Tailored Solutions for Flexible Data Exchange

The integration framework supports data exchange through various formats and protocols, ensuring compatibility with most external systems. This enables our platform to either initiate or receive data transfers based on your requirements.

1. Connecting via Existing Import/Export Platform API using Bearer Tokens

The platform provides robust import and export functionalities through predefined API endpoints secured using Bearer Token authentication. This method allows for seamless data transfer by leveraging long-living OAuth tokens.

Supported Data Formats

  • JSON (Preferred)
  • XML
  • XLS(X)

Supported Protocols

  • HTTP(S)

Authentication

  • Bearer Token Authentication (OAuth2): The system currently issues long-living tokens for secure access. In the future, tokens will be client-requestable, as demonstrated in calendar integration scenarios.

Concepts and Definitions

There are no predefined, “standard” endpoints exposed by default. Instead, we enable specific import or export functionalities upon customer request, referred to as “import definitions” and “export definitions”. These definitions translate data between the platform and third-party systems.

Importing data

Importing is an asynchronous process. Each import task is put in the queue and can take up to 10 minutes to finish

Refer to our Postman Documentation

If you want to import data via our standard API, you need to follow these steps.

1. List Import Definitions

Get a list of available import definitions. These are the definitions that are pre-created and enabled for you. While it contains many standard definitions, custom definitions can also be created on request as part of Customization.

This is example output. It might have additional fields based on the import type

[
    {
        "className": "Sofeast\\BuyingOfficeNamespace\\ImportPresets\\all\\DefectsImport",
        "config": {
            "category": "defects",
            "name": "Defects",
            "description": "Import defects to the platform",
            "details": ""
        },
        "extras": {
            "example": "all/ImportPresets/Defects.example.xlsx"
        },
        "limits": {
            "max": 10000,
            "chunksAllowed": true,
            "chunkSize": 1000
        },
        "getEmbedDefinitions": [],
        "path": "all/ImportPresets/Defects"
    }
]

Copy the path attribute of the desired definition.

2. Start Import

Using the path attribute as a parameter, send a POST request to initiate the import. The body of the request should be an array of arrays containing data following the import structure or an Excel example. The response contains job_id which can be used to get the import status.

3. Monitor Import Status

Use a separate endpoint to inquire about the import status using job_id from the previous step.

Exporting data

1. List Export Definitions

Similar to import definitions, the output contains export presets that are available. Use the path attribute for the desired preset to request an export.

2. Request Export

Exporting is a synchronous process. The response is provided immediately.

Request data export using the definition path and desired format.

Documentation

All API requests require a Bearer Token:

Refer to our Postman Documentation for detailed API reference and examples.

2. Using Tailored Solutions for Flexible Data Exchange

Our platform supports custom integration solutions that allow flexible data exchange using various protocols and formats. This method is ideal when connection initiation can occur from either our platform or the third-party system.

Supported Data Formats

  • JSON (Preferred)
  • XML
  • CSV
  • XLS(X)

Supported Protocols

  • HTTP(S)
  • FTP(S) (we do provide an ftp server for uploads)

Authentication Methods

  • When Third-Party is Initiator:
    • Bearer Token (OAuth2) with long-living tokens.
  • When Our Platform is Initiator:
    • Bearer Token (or any custom header-based authentication)
    • Basic Auth (username/password)

Data Exchange Intervals

Both Export and Import jobs can be initiated by our platform on different occasions:

  • When certain events occur on the platform (via Automation), e.g., when Inspection is completed.
  • On an interval basis (via Schedule), e.g., every day or every hour.
  • On request (via platform tools or API).

If you encounter any issues or need further assistance, feel free to reach out to our support team.