Developer tools
TABLE OF CONTENTS
1. OPEN API
Onix supports an OPEN 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 testing is limited to the timeframe of a given integration project. For production, it is limited to the service subscription
(Our Web API will be terminated by mid-August 2024)
Connect to API
Production environment:
Documentation: https://openapi.onixwork.com/swagger/index.html
Base URL: https://openapi.onixwork.com
Sandbox environment:
Documentation: https://openapi-sandbox.onixwork.com/swagger/index.html
Base URL: https://openapi-sandbox.onixwork.com
Data-exchange: JSON
Secured by: Token
Functional categories
1.1 Common (Get token)
1.2 Company (Get company information)
1.3 Equipment (Get equipment information)
1.1 Common
(Get predefined token)
Common functions for getting token and some system data.
https://openapi.onixwork.com/swagger/index.html
(In Common section)
1.2 Company
(Get company information)
The functions to get the company’s important information, such as locations, departments, areas, products, pictures, control categories, and so on.
https://openapi.onixwork.com/swagger/index.html
(In Company section)
1.3 Equipment
(Get equipment information)
The functions to get the information of equipment in Onix Work, such as equipment details, properties, job-intervals, documents, and pictures.
https://openapi.onixwork.com/swagger/index.html
(In Equipment section)
2.0 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.
(Will be terminated by July 2024)
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)
2.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
2.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
2.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
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 Imported 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.