TAP API Overview and Setup

Last updated
Save as PDF

Overview

This page is designed to help developers quickly set up and interact with the API. It provides step-by-step instructions to ensure a smooth integration experience.

TAP API Endpoints

The TAP API adheres to Microsoft's OData standard for all URL elements and parameters. You can find a detailed guide to these features here. The latest TAP API endpoints are available on the API Explorer Page. Visit this page to view all available endpoints in TAP. For additional endpoints and detailed usage, refer to the TAP API Documentation page.

Prerequisites

Before using the API, ensure you have the following:

An active account on the TAP application and Swagger
API key or authentication credentials
Basic understanding of RESTful APIs and JSON

Where and How to Find Your Credentials

To use the TAP API, you need authentication credentials. Follow these steps to locate them:

Log in to TAP.
Navigate to the Swagger section within the TAP dashboard.
Enter the Client ID and Client Secret Key provided by the support team.
Upon successful validation, a Bearer token will be generated. This token remains valid for 60 minutes.
Use the Bearer token in your request headers for authentication when making API requests.

Authentication

The API uses the ‘Bearer’ method for secure access. Include your API key/token in the request headers.

Example:

GET /endpoint HTTP/1.1
Host: api.example.comAuthorization: Bearer YOUR_API_KEY

Base URL

All API requests should be made to the following base URL:

https://default.tap.thinksmart.com/prod/api/swagger-docs/v1

Making API Requests

Request Structure

Each API request follows a standard structure:

Method: GET, POST, PUT, DELETE
Headers: Include content type and authentication token
Body (for POST/PUT): JSON payload

Example Request

POST /users HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
  "name": "John Doe",
  "email": "johndoe@example.com"
}

Handling API Responses

Responses will be returned in JSON format with the following structure:

{
  "status": "success",
  "data": { ... },
  "message": "Request processed successfully"
}

Common Status Codes

200 OK – Successful request
201 Created – Resource successfully created
400 Bad Request – Invalid request parameters
401 Unauthorized – Authentication failed
500 Internal Server Error – The server encountered an error

Error Handling

If an error occurs, the response will contain an error message and code. Example:

{
  "status": "error",
  "error": {
    "code": 400,
    "message": "Invalid email format"
  }
}

For further information or any questions, please reach out to the support team.