Tim - Support

Overview

This document describes the procedure for uploading data to the Tim API. It outlines the steps required to obtain the necessary credentials, generate an authentication token, and successfully call the ExternalObject endpoint.

Obtaining a Tim-API Key

See Access to the TimApi

API operations. Store them securely.

Generating a Bearer Token

To generate a Bearer Token, follow these steps:

1. Open the Swagger UI at:
   https://start.timsaas.com/TimApi/swagger/ui/index

   Or navigate directly to the token generation endpoint:
   https://start.timsaas.com/TimApi/swagger/ui/index#!/ApiAccess/ApiAccess_Get

2. Enter the following values in the request form:

   • Tenant ID
   • Email  your Microsoft account email
   • API Key

3. Click Execute to generate the Bearer Token.

Authentication

Use the generated Bearer Token for all authenticated API requests. The Authorization header must be formatted as follows:

Authorization: Bearer <your_token>

Token & Key Validity

Endpoint: ExternalObject

The ExternalObject endpoint allows external applications to send JSON data to Tim.

Endpoint Details

• Method: POST
• URL: /api/ExternalObject

Authentication

A valid Bearer Token is required. Include the token in the Authorization header.

Parameters

Example Request

POST /api/ExternalObject?tenantId=123
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json

Request Body example:

{
  "Type": "QUOTE",
  "Object": {
    "id": 260700008,
    "generalInformation": {
      "id": "number",
      "name": "string",
      "marketId": "number"
    }
  }
}

Type Field

The Type field must be one of the following values:

• QUOTE
• ENGAGEMENT

Important Notes

• A Bearer Token is valid for 30 minutes. After expiration, a new token must be generated.
• An API Key is valid for 6 months. After expiration, a new API Key must be requested.
• Always ensure secure storage of credentials and tokens.

Additional Reference

Swagger UI
https://start.timsaas.com/TimApi/swagger/ui/index?#!/ExternalObject