v3.0.0

Documentation API

Guide complet pour l'intégration des services Alyachan API. Accédez aux points de terminaison IA, téléchargeurs de médias et utilitaires de données avec des normes RESTful sécurisées et évolutives.

01 — Commencer

Configuration du Compte

L'accès aux points de terminaison API nécessite un compte vérifié. Nous proposons des options d'inscription flexibles (Email, Google, Discord) pour accélérer votre processus d'intégration.

Gestion des Clés API

Après connexion, accédez au Tableau de Bord du Compte dans l'onglet <strong>API KEY</strong>. Cette clé est l'identifiant secret de votre application.

◦ Pour récupérer votre Clé API, veuillez appuyer sur le bouton "Copier"

Ne partagez jamais votre Clé API dans du code côté client ou des dépôts publics.

◦ Pour modifier votre Clé API, veuillez appuyer sur le bouton "Générer une Clé" suivi du bouton "Mettre à Jour la Clé"

Liste Blanche IP Plan d'Abonnement

Fonctionnalité de sécurité pour restreindre l'accès à la Clé API uniquement à partir d'adresses IP de serveur enregistrées. Vous devez configurer l'IP avant d'utiliser votre Clé API

IP Statique : Enregistrer manuellement l'IP du serveur de production.
Tout Autoriser : Cochez cette option si le serveur utilise une IP Dynamique (Non recommandé pour la production).

02 — Intégration

Installation de la Bibliothèque

SDK Officiel

npm install @alyachan/api

HTTP Générique

npm install axios

Exemples d'Utilisation

Pour obtenir / rechercher des points de terminaison, veuillez visiter la Référence API

Serveur principal : https://api.alyachan.dev

Serveurs de secours :

https://api-v2.alyachan.dev

index.js (SDK)Recommandé

const AlyaApi = require('@alyachan/api').default
const Api = AlyaApi('https://api.alyachan.dev/api', 'sk_prod_xxxxxxxx')

async function main() {
  try {
    const res = await Api.post('/ai/text2img', {
      'prompt': 'Cyberpunk city',
      'models': 'Japanese'
    })
    console.log(res)
  } catch (e) {
    console.error(e)
  }
}

request.js (Axios) POST

const axios = require('axios')

const config = {
  'method': 'POST',
  'url': 'https://api.alyachan.dev/api/ai/text2img',
  'headers': {
    'Authorization': 'Bearer sk_prod_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  'data': { 'prompt': 'Cyberpunk city', 'models': 'Japanese' }
}

axios(config)
  .then(r => console.log(r.data))
  .catch(e => console.error(e))

Réponses Standard

Code	Signification	Description
200	OK	Requête traitée avec succès.
400	Mauvaise Requête	Les paramètres d'entrée sont incorrects ou manquants.
401	Non Autorisé	Clé API invalide ou non fournie.
429	Limite de Débit	Limite de requêtes quotidiennes dépassée.