Tags API

1. Overview

The Jakamo Tags API is an XML based API over HTTPS/REST. With the Jakamo Tags API tags can be added to claims and purchase orders. See more detailed description about Tags and Tag groups from the Jakamo User Guide.

Tags API is available only if your company has also PO API or Claim API in use!

2. Authorization

The Tags API requires Claim API integration or Purchase Order API integration. The Tags API uses basic authentication as an authentication method. The username and the password used in the hashed token are the same as for the Claim API or Order API integration in the Jakamo Integrations setting page.

3. Tags API endpoints

Jakamo environment	HTTP request	Jakamo API endpoint
Test environment	POST	https://demo.thejakamo.com/api/tags/add
Production environment	POST	https://www.thejakamo.com/api/tags/add

4. Example request

In this example, tags Tag one, Tag two and Tag three are added to purchase order in Jakamo.

    <TagList>
        <!-- Indicates the type of item the tags are to be added. One of "claim", "order". -->
        <ItemType>order</ItemType>
        <!-- ID to identify the item the teags are to be added. For claims this is matched to "Claim id" and for orders this is matched to "Purchase order number". -->
        <ID>PO 882</ID>
        <!-- List of tags to be added. Each <Tag>-element is considered as one tag. -->
        <Tags>
            <Tag>Tag one</Tag>
            <Tag>Tag two</Tag>
            <Tag>Tag three</Tag>
        </Tags>
    </TagList>

Help & Support

Didn't you find what you were looking for? Send an email to Jakamo support (support@thejakamo.com) and we will help you.