Setup and use

Setup and use

This guide describes what needs to be in place to start using Order Drop API – access, API user and settings – and the difference between using the API via a ready-made integration versus connecting an external system directly to it.

TABLE OF CONTENTS

• Access control and permissions
• Prerequisites
• Creating an API user
• Configuring settings
• Use via a ready-made integration
• Use from an external system (direct connection)

Access control and permissions

Ordinary users and customers do not have direct access to Order Drop API. Access requires an API user with an access key. Orders created via the API are visible to everyone with access to the order view – they are handled as ordinary orders.

Prerequisites

Before order import works, the following must be in place:

• Licence: none – Order Drop API is part of the base system
  
  
• API user with an access key (created by the system administrator)
  
  
• Products registered in Telaris with the correct product number or SKU. Lines without a match are added without a product link (unless «Reject missing product» is enabled)
  
  
• Customer data: the data sent in must contain either the customer's email address or customer number with a filled-in value. Other identifiers (organisation number, internal customer ID, Tripletex ID) can be used for the lookup itself, but are not sufficient alone – the request is rejected before the lookup happens

Creating an API user

An API user is created by the system administrator and gets an access key used for authentication in all API calls:

1. Contact the system administrator to create an API user
2. Receive the access key
3. Provide the key to whoever will integrate – either a Telaris integration team or an external party

The access key is permanent and does not need to be renewed at regular intervals.

Tip: The step-by-step procedure for creating the API user is described in the article «Create API user».

Configuring settings

The settings for Order Drop API are configured via Telaris support/project There are no dedicated fields – the settings are entered as key/value pairs:

• Reject missing customer– enable if only existing customers should have orders imported
  
  
• Reject missing product – enable if all products in the order lines must exist in Telaris
  
  
• Update delivery address – enable to store the delivery address as a separate address object instead of free text
  
  
• Notification recipient – set an email address to receive notification of new orders
  
  

For information: A full explanation of what each setting does is found in the article «How order import works».

Use via a ready-made integration

Order Drop API is normally not used directly by end users, but by integrations. Once an integration is set up, orders flow automatically into Telaris:

• The WooCommerce integration – configured as an integration app under Administration → Integrations
• Telaris Connect – receives orders from connected Telaris instances
  
  

For ready-built integrations, all the API work is already handled. The setup is then what is described in the relevant integration's own article.

Use from an external system (direct connection)

External parties – customers, partners or third-party developers – can connect directly to Order Drop API. This is relevant when:

• The customer has its own order system, ERP or web shop without a ready-made Telaris integration
• A partner or supplier wants to send orders automatically
• A developer is building a custom integration
  
  

How to get started (Telaris' side):

1. The system administrator creates an API user and shares the access key with the external party
2. The external party receives Telaris' API documentation describing data format and authentication
3. The external party builds the integration in its system – typically by sending order data to the API via a standard HTTP call
4. Test with a sample order and verify that it is created correctly in Telaris
5. Put into production
   
   

NOTE: Telaris' side covers creating the API user, configuring settings, sharing documentation and verifying that intake works, plus a brief walkthrough of the API. Testing and troubleshooting where Telaris is involved come in addition and vary with the external party's competence. The external party's own development work – building, formatting, testing and troubleshooting on its side – lies outside Telaris' area of responsibility.

For information: The API documentation is technical and intended for developers. Onboarding and support staff normally do not need to read it – it is enough to know it exists and can be shared with the external party.