İçeriğe geç
ajan.io

Belgeler menüsü

Bu sayfada

Integration oluştur

Workspace'inizde yeni bir özel entegrasyon oluşturun

Workspace'inizde yeni bir özel entegrasyon oluşturur. Oluşturduktan sonra entegrasyona action ve trigger ekleyebilirsiniz.

Base URL

https://api.ajan.io/integrations/v1/create

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

Required Scopes

Bu endpoint INTEGRATION_API kapsamı gerektirir.

Parameters

ParameterTypeRequiredDescription
namestringYesEntegrasyon adı (maks. 40 karakter)
descriptionstringNoEntegrasyon açıklaması (maks. 90 karakter)

Example

javascript
const axios = require("axios");

async function createIntegration() {
  const response = await axios.post(
    "https://api.ajan.io/integrations/v1/create",
    {
      name: "My Custom Integration",
      description: "Connects to my internal company API for data retrieval"
    },
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
      }
    }
  );

  console.log("Created integration:", response.data.integration);
  return response.data.integration.id;
}

createIntegration();

Response Format

Success Response (201 Created)

typescript
{
  integration: {
    id: string;          // UUID of the created integration
    name: string;        // Integration name
    description: string; // Integration description
    createdAt: string;   // ISO 8601 timestamp
  };
}

Example Response

json
{
  "integration": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Custom Integration",
    "description": "Connects to my internal company API for data retrieval",
    "createdAt": "2025-02-18T10:30:00.000Z"
  }
}

Error Handling

Status CodeDescription
400Geçersiz istek gövdesi (ad çok uzun, geçersiz karakterler)
401Geçersiz veya eksik API anahtarı
429Rate limit aşıldı
500İç sunucu hatası

Sonraki adımlar

Bir entegrasyon oluşturduktan sonra genellikle şunları yaparsınız:

  1. Agent'ların yürütebileceği action ekleyin
  2. İş akışlarını başlatan trigger ekleyin
  3. Entegrasyonunuz gerektiriyorsa authentication yapılandırın

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.