Integrations API genel bakış

Integrations API, ajan workspace'inizde özel entegrasyonları programatik olarak oluşturmanızı ve yönetmenizi sağlar. Dahili araçlarınıza, API'lerinize ve servislerinize bağlanan entegrasyonlar geliştirin.

Base URL

https://api.ajan.io

Dedicated deployments Tüm isteklerde api.ajan.com'u /api/public ile değiştirin.

API Key Scopes

Integrations API belirli API anahtarı kapsamları gerektirir:

Tam Integrations API'ye erişmek için workspace settings içinde INTEGRATION_API kapsamına sahip bir API anahtarı oluşturun.

Kullanılabilir endpoint'ler

Integrations

Actions

Action'lar, agent'ların yürütebileceği entegrasyonlara ekleyebileceğiniz yeteneklerdir. Her action'ın bir requiresConfirmation varsayılanı vardır. Agent'lar, iş akışları ve otomasyonlar action'ı çalıştırırken bunu geçersiz kılabilir.

Triggers

Trigger'lar, entegrasyonların harici olaylara göre iş akışlarını başlatmasını sağlar.

Quick Start

Basit bir action içeren entegrasyon oluşturma örneği:

const axios = require("axios");

const API_KEY = "YOUR_API_KEY";
const BASE_URL = "https://api.ajan.io";

// 1. Create an integration
const integrationResponse = await axios.post(
  `${BASE_URL}/integrations/v1/create`,
  {
    name: "My Custom Integration",
    description: "Connects to my internal API"
  },
  {
    headers: {
      Authorization: `Bearer ${API_KEY}`,
      "Content-Type": "application/json"
    }
  }
);

const integrationId = integrationResponse.data.integration.id;

// 2. Add an action to the integration
const actionResponse = await axios.post(
  `${BASE_URL}/integrations/v1/${integrationId}/actions/create`,
  {
    name: "Get User Data",
    description: "Retrieves user information from the internal API",
    code: `
      const response = await ld.request({
        method: "GET",
        url: "https://my-api.example.com/users/" + data.input.userId
      });
      return response.json;
    `,
    inputFields: [
      {
        label: "User ID",
        type: "TEXT",
        description: "The ID of the user to retrieve",
        required: true
      }
    ]
  },
  {
    headers: {
      Authorization: `Bearer ${API_KEY}`,
      "Content-Type": "application/json"
    }
  }
);

console.log("Action created:", actionResponse.data.action);

Kullanım senaryoları

• Internal Tools Integration: Agent'ları şirketinizin dahili API'lerine, veritabanlarına veya servislerine bağlayın
• Custom Workflows: Harici olaylara göre iş akışlarını tetikleyen entegrasyonlar oluşturun
• Data Enrichment: Birden fazla kaynaktan veri getiren ve zenginleştiren action'lar oluşturun
• Automated Reporting: Rapor üreten ve dağıtan entegrasyonlar geliştirin

Rate Limits

Integrations API, workspace ve API anahtarı başına 500 RPM ile sınırlıdır. Token limiti uygulanmaz. Limiti aşarsanız 429 yanıtı alırsınız. Bekleyin ve exponential backoff ile yeniden deneyin.

ajan, API anahtarınızı korumak ve uygulamalarınızın güvenliğini sağlamak için tarayıcı kaynaklı istekleri bilinçli olarak engeller. Daha fazla bilgi için API Key Best Practices kılavuzuna bakın.