XML Direct

Introduction XML Direct is a standardized integration interface designed to provide seamless, structured access to business-critical data through a single unified endpoint. The interface is modular and configurable, allowing organizations to select only the components relevant to their needs.

All components within the XML Direct interface follow a fixed field structure, ensuring a uniform data format across all Directo customer environments. This common structure enables faster implementation and easier maintenance, as no customer-specific development is required.

• Modular Architecture: Components (e.g., customers, invoices, inventory) can be enabled individually according to specific integration requirements.
• Uniform Data Format: Field definitions and data structure are standardized across all implementations, minimizing inconsistencies.
• Shared Development Model: Enhancements and updates are applied centrally and benefit all users, with no need for client-specific customization.
• Secure Access via API Keys:
  • Multiple API keys can be generated and assigned to different partners.
  • Each API key can be restricted to access only specific components.
  • This provides enhanced flexibility and data security.

Prior to implementation, it is essential to:

• Define the scope of integration.
• Identify the required components.
• Ensure the technical partner has access to the necessary documentation and authentication details.

Once agreed upon, activating the XML Direct interface is straightforward and does not require any Directo-side development or configuration.

To find the interface XML key and provide it to the developer:

1. Log in to Directo with a user who has SUPER rights
2. Since there can be multiple API keys, you need to open the employee card for whom the key has been created. For example, open the employee card 'XML'
   
3. Go to the Admin tab
   
4. Go to the XML interfaces section
5. On the line of the required interface, press the button to see the key

Access to the interface is via the POST method, form/urlencoded, to the following URL: https://login.directo.ee/xmlcore/cap_xml_direct/xmlcore.asp

A token must be used for access (see the API Key obtained in the previous chapter). The token replaces the older interface types' appkey and database name all at once. The token must be sent via the POST method in the TOKEN variable (similar to submitting an HTML form) to the given URL to get a result. In case of an incorrect or improperly sent token, the response is <result type=„5“ desc=„Unauthorized“/>. In case token is missing the response is <err>token required</err>.

curl example

curl --location 'https://login.directo.ee/xmlcore/cap_xml_direct/xmlcore.asp' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=••••••' \
--data-urlencode 'get=1' \
--data-urlencode 'what=xxxxx' \
--data-urlencode 'ts=xx.xx.xxxx'

The price depends on the selected components.
The output of deleted documents is included in the price and is free of charge.

The price for an additional API key is €0 per month.
If multiple API keys have the same components, the fee for them is charged only once.

Example:

• API key A contains outputs: customer and item
• API key B contains outputs: customer and order

→ In this case, the fee is only for three unique components: customer, item, and order.

XML Direct interface testing link https://login.directo.ee/xmlcore/cap_xml_direct/webupload.html

• Output interfaces show all records, and restrictions can be made with query filters!
• The functionality of input interfaces can be controlled with TRANSPORT PARAMETERS - please read more about the Transport Parameters of the input component. By default, a transport parameter with an empty or '0' value is not required.
• Some inputs also support setting default values.

Selectable components

what=invoice Schema

To configure default invoice values, read more here

what=order Schema

To configure default order values, read more here

what=receipt Schema

what=transaction Schema

• When posting and modifying, code and email are always required!
  

what=customer Schema

• When posting and modifying, code is always required!
  

what=supplier Schema

• When filling out the item card, the interface fills the fields according to the rules mandatory

what=item Schema

what=purchase Schema

what=resource Schema

• what=item Schema
  Filters: class,code,type,barcode,supplier,supplieritem,closed,ts

• what=itemstocklimit Schema
  Filters: code,stock,ts

• what=itempackage Schema
  Filters: code,ts

• what=itemrelitem Schema
  Filters: code,ts

• what=customer Schema
  Filters: code,loyaltycard,regno,email,phone,closed,ts

• what=supplier
• Schema
  
• Filters: code,regno,email,closed,ts

• what=stocklevel Schema
  
• what= stocklevel_sn Schema
  
• what=stocklevel_variant Schema
  
• Filters: code,stock,ts

• what=priceformularow Schema
  Filters: class,code,ts

• what=itemclass Schema
  Filters: code,master

• what=invoice Schema
  Filters: number,customercode,transactiondate,date1,date2,ts, ordernumber

• what=order Schema
  Filters: number,date1,date2,ts, projekt, customerordernumber, stock, status

• what=transaction Schema
  Filters: number,date1,date2,ts

• what=receipt Schema
  Filters: number,date1,date2,ts

• what=purchase Schema
  Filters: number,date1,date2,supplier,confirmed,status,ts

• what=resource Schema
  
• Filters: number,confirmed,ts

• what=delete Schema
  Filters: number,code,document,ts