v3.0.0

Documentação da API

Guia completo para integração dos serviços Alyachan API. Aceda a endpoints de IA, descarregadores de média e utilitários de dados com padrões RESTful seguros e escaláveis.

01 — Começar

Configuração da Conta

O acesso aos endpoints da API requer uma conta verificada. Fornecemos opções de registo flexíveis (Email, Google, Discord) para acelerar o seu processo de integração.

Gestão de Chaves API

Após iniciar sessão, navegue até ao Painel de Controlo da Conta no separador "API KEY". Esta chave é a credencial secreta da sua aplicação.

◦ Para obter a sua Chave API, por favor pressione o botão "Copiar"

Nunca partilhe a sua Chave API em código do lado do cliente ou repositórios públicos.

◦ Para alterar a sua Chave API, por favor pressione o botão "Gerar Chave" seguido do botão "Atualizar Chave"

Lista Branca de IP Plano de Subscrição

Funcionalidade de segurança para restringir o acesso à Chave API apenas a partir de endereços IP de servidor registados. Deve configurar o IP antes de usar a sua Chave API

IP Estático: Registar manualmente o IP do servidor de produção.
Permitir Todos: Marque esta opção se o servidor utilizar IP Dinâmico (Não recomendado para produção).

02 — Integração

Instalação da Biblioteca

SDK Oficial

npm install @alyachan/api

HTTP Genérico

npm install axios

Exemplos de Utilização

Para obter / pesquisar endpoints, por favor visite a Referência da API

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

Servidores de backup :

https://api-v2.alyachan.dev

index.js (SDK)Recomendado

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))

Respostas Padrão

Código	Significado	Descrição
200	OK	Pedido processado com sucesso.
400	Pedido Inválido	Os parâmetros de entrada estão incorretos ou em falta.
401	Não Autorizado	Chave API inválida ou não fornecida.
429	Limite de Taxa	Limite de pedidos diários excedido.