IT Glue API Patterns

Overview

The IT Glue API follows the JSON:API specification, providing access to organizations, configurations (assets), contacts, passwords, documents, and flexible assets. This skill covers authentication, query building, pagination, error handling, and performance optimization patterns.

Authentication

API Key Authentication

IT Glue uses API key authentication via the x-api-key header:

GET /organizations
x-api-key: YOUR_API_KEY
Content-Type: application/vnd.api+json

Required Headers: | Header | Value | Description | |--------|-------|-------------| | x-api-key | Your API key | Authentication token | | Content-Type | application/vnd.api+json | JSON:API content type |

Environment Variables

export IT_GLUE_API_KEY="ITG.your-api-key-here"
export IT_GLUE_REGION="us"  # us, eu, or au

Regional Endpoints

IT Glue operates in multiple regions:

| Region | Base URL | Description | |--------|----------|-------------| | US | https://api.itglue.com | United States | | EU | https://api.eu.itglue.com | European Union | | AU | https://api.au.itglue.com | Australia |

JSON:API Structure

Request Format

IT Glue follows JSON:API specification for request bodies:

{
  "data": {
    "type": "organizations",
    "attributes": {
      "name": "Acme Corporation",
      "organization-type-id": 12345,
      "organization-status-id": 1
    }
  }
}

Response Format

{
  "data": {
    "id": "123456",
    "type": "organizations",
    "attributes": {
      "name": "Acme Corporation",
      "organization-type-id": 12345,
      "organization-status-id": 1,
      "created-at": "2024-01-15T10:30:00.000Z",
      "updated-at": "2024-02-15T14:22:00.000Z"
    },
    "relationships": {
      "configurations": {
        "data": [
          {"id": "789", "type": "configurations"}
        ]
      }
    }
  },
  "included": [],
  "meta": {
    "current-page": 1,
    "next-page": 2,
    "prev-page": null,
    "total-pages": 5,
    "total-count": 125
  }
}

Key Concepts

| Term | Description | |------|-------------| | data | Primary resource or array of resources | | attributes | Resource properties | | relationships | Links to related resources | | included | Sideloaded related resources | | meta | Pagination and metadata |

Filtering

Filter Syntax

IT Glue uses query parameter filtering:

GET /organizations?filter[name]=Acme
GET /organizations?filter[organization-status-id]=1
GET /configurations?filter[organization-id]=123456

Common Filter Parameters

| Endpoint | Filter | Example | |----------|--------|---------| | Organizations | filter[name] | Partial name match | | Organizations | filter[organization-type-id] | By type | | Organizations | filter[organization-status-id] | By status | | Configurations | filter[organization-id] | By organization | | Configurations | filter[configuration-type-id] | By type | | Configurations | filter[configuration-status-id] | By status | | Contacts | filter[organization-id] | By organization | | Passwords | filter[organization-id] | By organization | | Documents | filter[organization-id] | By organization |

Multiple Filters

Combine filters with multiple parameters:

GET /configurations?filter[organization-id]=123&filter[configuration-type-id]=456&filter[configuration-status-id]=1

PSA Integration Filter

Filter resources by PSA ID for cross-platform lookups:

GET /organizations?filter[psa-id]=12345
GET /contacts?filter[psa-id]=67890

Sorting

Sort Syntax

Use the sort parameter with field names:

GET /organizations?sort=name
GET /organizations?sort=-created-at
GET /configurations?sort=name,-updated-at

Sort Direction: | Prefix | Direction | Example | |--------|-----------|---------| | (none) | Ascending | sort=name | | - | Descending | sort=-created-at |

Common Sort Fields

| Endpoint | Fields | |----------|--------| | Organizations | name, created-at, updated-at | | Configurations | name, hostname, created-at, updated-at | | Contacts | name, first-name, last-name, created-at | | Passwords | name, created-at, updated-at | | Documents | name, created-at, updated-at |

Pagination

Request Pagination

GET /organizations?page[size]=50&page[number]=1

Pagination Parameters: | Parameter | Description | Default | Max | |-----------|-------------|---------|-----| | page[size] | Items per page | 50 | 1000 | | page[number] | Page number (1-based) | 1 | - |

Response Metadata

{
  "meta": {
    "current-page": 1,
    "next-page": 2,
    "prev-page": null,
    "total-pages": 5,
    "total-count": 247
  }
}

Efficient Pagination Pattern

async function fetchAllOrganizations() {
  const allItems = [];
  let page = 1;
  let hasMore = true;

  while (hasMore) {
    const response = await fetch(
      `${baseUrl}/organizations?page[size]=1000&page[number]=${page}`,
      { headers: { 'x-api-key': apiKey } }
    );

    const data = await response.json();
    allItems.push(...data.data);

    hasMore = data.meta['next-page'] !== null;
    page++;
  }

  return allItems;
}

Sideloading with Includes

Include Related Resources

Retrieve related resources in a single request:

GET /configurations/123?include=organization,configuration-interfaces
GET /organizations/456?include=configurations,contacts,passwords

Common Includes

| Endpoint | Available Includes | |----------|-------------------| | Configurations | organization, configuration-type, configuration-status, configuration-interfaces, related-items | | Contacts | organization, contact-type, location | | Passwords | organization, password-category | | Documents | organization | | Flexible Assets | organization, flexible-asset-type |

Response with Includes

{
  "data": {
    "id": "123",
    "type": "configurations",
    "attributes": { "name": "DC-01" },
    "relationships": {
      "organization": {
        "data": { "id": "456", "type": "organizations" }
      }
    }
  },
  "included": [
    {
      "id": "456",
      "type": "organizations",
      "attributes": {
        "name": "Acme Corporation"
      }
    }
  ]
}

Rate Limiting

Rate Limit Details

IT Glue enforces rate limits to ensure fair API usage:

| Metric | Limit | |--------|-------| | Requests per 5 minutes | 3000 | | Burst limit | ~100 requests/second |

Rate Limit Headers

X-RateLimit-Limit: 3000
X-RateLimit-Remaining: 2847
X-RateLimit-Reset: 1708012800

Rate Limit Response

When rate limited (HTTP 429):

{
  "errors": [
    {
      "status": "429",
      "title": "Rate Limit Exceeded",
      "detail": "Too many requests. Please try again later."
    }
  ]
}

Retry Strategy

async function requestWithRetry(url, options, maxRetries = 5) {
  for (let attempt = 0; attempt < maxRetries; attempt++) {
    try {
      const response = await fetch(url, options);

      if (response.status === 429) {
        const retryAfter = response.headers.get('Retry-After') || 60;
        const jitter = Math.random() * 5000;
        await sleep(retryAfter * 1000 + jitter);
        continue;
      }

      return response;
    } catch (error) {
      if (attempt === maxRetries - 1) throw error;

      // Exponential backoff with jitter
      const delay = Math.pow(2, attempt) * 1000 + Math.random() * 1000;
      await sleep(delay);
    }
  }
}

CRUD Operations

Create (POST)

POST /organizations
Content-Type: application/vnd.api+json
x-api-key: YOUR_API_KEY

{
  "data": {
    "type": "organizations",
    "attributes": {
      "name": "New Client Inc",
      "organization-type-id": 12345,
      "organization-status-id": 1
    }
  }
}

Read (GET)

Single resource: `

Como adicionar

Cole no README do seu repo

Skills relacionadas

MoneyPrinterTurbo

weather-svg-creator

asana-automation

payment-integration

Receba novas skills de Automação toda segunda