İçeriğe geç
ajan.io

Belgeler menüsü

Bu sayfada

Integration getir

Belirli bir entegrasyonun ayrıntılarını alın

Belirli bir entegrasyon hakkında action'ları ve yapılandırması dahil ayrıntılı bilgi döndürür.

Base URL

https://api.ajan.io/integrations/v1/{integrationId}

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
integrationIdstringYesEntegrasyonun UUID'si

Example

javascript
const axios = require("axios");

async function getIntegration(integrationId) {
  const response = await axios.get(
    `https://api.ajan.io/integrations/v1/${integrationId}`,
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY"
      }
    }
  );

  console.log("Integration:", response.data.integration);
}

getIntegration("550e8400-e29b-41d4-a716-446655440000");

Response Format

Success Response (200 OK)

typescript
{
  integration: {
    id: string;
    name: string;
    description: string;
    authType: string;
    authTestCode: string | null;
    authFields: Array;
    oauthClient: object | null;
    actions: Array<{
      id: string;
      name: string;
      slug: string;
      description: string;
      code: string | null;
      order: number;
      requiresConfirmation: boolean;
      inputFields: Array<{
        slug: string;
        label: string;
        type: string;
        description: string;
        placeholder: string | null;
        required: boolean;
        order: number;
        options: Array<{label: string, value: string}> | null;
        allowMultiSelect: boolean | null;
        contextActionId: string | null;
      }>;
    }>;
    triggers: Array<{
      id: string;
      name: string;
      slug: string;
      description: string;
    }>;
  };
}

Error Handling

Status CodeDescription
400Geçersiz entegrasyon ID biçimi
401Geçersiz veya eksik API anahtarı
403Bu entegrasyona erişim yok
404Entegrasyon bulunamadı
429Rate limit aşıldı

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.