Developers/API

Quickly and efficiently generate all legally required documents for your customers electronically.

Onix Work Web API

Documentation: https://onixwork.com/api/Doc/
Base URL: https://onixwork.com/api
Secured by: Token

Terms & Conditions

View our Terms & Conditions for connecting to Onix Work.

Miss functionality?

We are constantly trying to expand our libraries. If you have suggestions for approvements or new functionality, feel free to discuss this in our Community.

Table of contents

    1. Web API

    Onix supports Web API for some common integrations. To be able to connect to these functions, you will need a token. This is a unique key for your company in Onix Work. Onix will provide this for both test and production purposes. The availability for test is limited to the time-frame of a given integration project. For production it is limited to the service subscription.

    Connect to API

    Production:

    Documentation : https://onixwork.com/api/Doc/
    Base URL: https://onixwork.com/api
    Test environment:
    Documentation : https://onixwork.com/api-test/Doc/
    Base URL: https://onixwork.com/api-test
    Data-exchange: JSON
    Secured by: Token

    Functional categories

    1.1 Order : (Transfer orders from your ERP system to Onix Work)
    1.2 Document (Transfer documents to Onix Work)
    1.3 Common (Get predefined bussiness values)

     

    1.1 Order

    (Transfer orders from your ERP system to Onix Work)

    It is possible to fully handle orders in Onix Work. However, many suppliers have their logistics stored in a seperate system (ERP or similar). Since orders are already created, it is possible to transfer this information to Onix Work, and handle creation and distribution of documents from the Order Module.

    Main parameters: Customer, Product, Quantity
    Target: Customer.

    https://onixwork.com/api/Doc/#/order

    1.2 Document

    (Transfer documents to Onix Work)

    In some cases a document (declaration of conformity, certificate, user manual, etc) is created outside Onix Work. As an alternative to attach these documents "equipment-by equipment" in Onix Work, they can be tranferred by the Document API.

    If the equipment does not exist, it will be created.
    There will always be a job created behind this document.
    The result is a searchable document based on equipment and job related information.

    Main Parameters: Customer, Equipment, Job, Document
    Target: My company or Customer (including Location).

    In order to add documents on existing equipment, the creation of the equipment must have been done from the Document API.

    All items must then have been given a locally unique key (ImportId) that can be referred to at a later call.

    https://onixwork.com/api/Doc/#/document

    1.3 Common

    (Get predefined bussiness values)

    Common functions are either needed for setup-purposes, or to collect metadata/keys for other functions.

    https://onixwork.com/api/Doc/#/common

     

    2. SOAP API

    Current SOAP API and contained functions will be discontinued and replaced by Web API.

    Onix have supported SOAP API for many years. These functions will be transferred to the new, more secure Web API platform. This tranfer will be done based on priority and volume of usage.

    Data-exchange: XML
    Secured by: XML-structured key

     

    Functional categories

    2.1 DataExport

    2.2 DocumentImportWCF

    2.1 DataExport

    Production:

    URL:    https://onixwork.com/dataexport/Client.svc
    WSDL: https://onixwork.com/dataexport/Client.svc?wsdl

    Test environment:
    URL:     https://onixwork.com/dataexportTest/Client.svc
    WSDL:  https://onixwork.com/dataexportTest/Client.svc?wsdl

    • GetDeliveredOrders
    • GetDailyDeliveredOrders
    • GetEquipmentByModifiedDate

    2.2 DocumentImportWCF (transferred to Web-API)

    Production:
    URL:    https://onixwork.com/DocumentImportWCF/DocumentImport.svc
    WSDL: https://onixwork.com/documentimportwcfTEst/DocumentImport.svc?wsdl

    Test environment:

    URL:    https://onixwork.com/DocumentImportWCFTest/DocumentImport.svc
    WSDL: https://onixwork.com/documentimportWcfTest/DocumentImport.svc?wsdl

     

    3. Formatted files

    Not all companies have their own IT department/developers that are capable of connecting to an API. In this case, we offer import by csv-formatted files (spread sheet).

     

    Categories

    3.1 Import by Wizard
    3.2 Import by Template

    3.1 Import by Wizard

    Onix Work support csv-formatted files for import. For standard import of objects like products and equipment, see [OnixWork]->[Settings]->[System]->[External data-sources]

    https://onixwork.com/prod/Setting + External data-sources (requires login to Onix Work)

    You will then find a wizard that will help you perform this action.

    3.2 Import by Template

    For more advanced imports including jobs and documents, contact Onix for a template. The import will then be handled in cooperation with our service department.

     

    4. Integration

    Onix offers two main functions for integration:

    4.1 Onix Maker (Transfer serialized equipment from producer to supplier)

    4.2 Onix Transfer (Transfer order/order lines from Supplier to customer)

    4.1 Onix Maker

    (Transfer serialized equipment from producer to supplier)

    By using Onix Maker, you can tag your equipment for identification by using RFID and/or QR codes.

    There is no better time to this than when the eqipment is being produced.

    This identification will help you uniquely identify any equipment from the moment it is created to the day it is used for the final time.

    This includes logistics, check of status and all kinds of inspections.

    You can read more about Onix-Maker here

    4.2 Onix Transfer

    (Transfer order/order lines from Supplier to customer)

    You can read more about Onix Transfer here