Aller au contenu principal

Guide d'utilisation du SDK OpenAPI

Ce document fournit des instructions détaillées sur la façon d'utiliser le SDK Tianji pour appeler les interfaces OpenAPI et obtenir un accès programmatique complet aux services Tianji.

Présentation​

Le SDK OpenAPI de Tianji est basé sur un client TypeScript généré automatiquement, offrant des méthodes d'appel d'API sécurisées par type. Grâce au SDK, vous pouvez :

  • Gérer les espaces de travail et les sites web
  • Récupérer des données analytiques et des statistiques
  • Opérer des projets de surveillance
  • Gérer des sondages
  • Gérer les flux et événements de chaînes
  • ...

Documentation complète de l'API

Installation et Initialisation​

Installer le SDK​

npm install tianji-client-sdk
# ou
yarn add tianji-client-sdk
# ou
pnpm add tianji-client-sdk

Initialiser le client OpenAPI​

import { initOpenapiSDK } from 'tianji-client-sdk';

initOpenapiSDK('https://votre-domaine-tianji.com', {
  apiKey: 'votre-clé-api'
});

API de Configuration Globale​

Obtenir la configuration système​

import { openApiClient } from 'tianji-client-sdk';

async function getSystemConfig() {
  try {
    const config = await openApiClient.GlobalService.globalConfig();
    
    console.log('Autoriser l\'inscription :', config.allowRegister);
    console.log('Fonctionnalités IA activées :', config.enableAI);
    console.log('Facturation activée :', config.enableBilling);
    
    return config;
  } catch (error) {
    console.error('Échec de l\'obtention de la configuration système :', error);
  }
}