Integrieren Sie ZyloPro in Ihre Anwendungen
https://api.zylopro.comRegistrieren Sie sich auf ZyloPro, um Ihr Konto und Ihre Organisation zu erstellen. Anschließend können Sie sich über die API anmelden, um ein Zugriffstoken zu erhalten.
Die API verwendet JWT-Token (Bearer). Fügen Sie das Token in den Authorization-Header Ihrer Anfragen ein:
Nach der Authentifizierung können Sie verfügbare Agenten auflisten, Analysen ausführen und Ergebnisse abrufen.
Die Authentifizierungs-Endpoints verwalten Benutzerkonten, Zugriffstoken und Passwörter.
/api/auth/registerRegistrierung einer neuen Organisation mit ihrem Eigentümer
{
"email": "string",
"password": "string",
"firstName": "string",
"lastName": "string",
"organizationName": "string"
}{ success: boolean, token?: string, refreshToken?: string, user?: UserDto }/api/auth/loginBenutzeranmeldung
{
"email": "string",
"password": "string"
}{ success: boolean, token?: string, refreshToken?: string, user?: UserDto }/api/auth/refreshZugriffstoken mit Refresh-Token erneuern
{
"refreshToken": "string"
}{ success: boolean, token?: string, refreshToken?: string }/api/auth/revokeRefresh-Token widerrufen (Abmeldung)
{
"refreshToken": "string"
}{ message: string }/api/auth/verify-emailE-Mail-Adresse mit dem per E-Mail erhaltenen Token verifizieren
{
"token": "string"
}{ message: string }/api/auth/forgot-passwordPasswortzurücksetzung anfordern
{
"email": "string"
}{ message: string }/api/auth/reset-passwordPasswort mit dem per E-Mail erhaltenen Token zurücksetzen
{
"token": "string",
"newPassword": "string"
}{ message: string }/api/auth/change-passwordPasswort ändern (angemeldeter Benutzer)
{
"currentPassword": "string",
"newPassword": "string"
}{ message: string }Die Agenten-Endpoints ermöglichen es, die 10 KI-Module der Plattform aufzulisten, zu abonnieren und auszuführen.
/api/agentsAlle verfügbaren Agenten auf der Plattform abrufen
AgentDto[]/api/agents/organizationVon der Organisation abonnierte Agenten abrufen (Admin)
AgentDto[]/api/agents/myVom angemeldeten Benutzer zugängliche Agenten abrufen
AgentDto[]/api/agents/{agentId}/subscribeEinen Agenten abonnieren (Organisationsebene)
{
"agentId": "int"
}{ message: string }/api/agents/{agentId}/unsubscribeEinen Agenten abbestellen
{
"agentId": "int"
}{ message: string }/api/agents/{code}/executeEinen Agenten mit Eingabedaten ausführen
{
"code": "string (ex: proposalcraft)"
}{
"inputData": "string",
"projectId": "guid? (optionnel)",
"metadata": "Record<string, string>? (optionnel)"
}{ success: boolean, status: string, executionId: guid, outputData?: string, error?: string }/api/agents/executions/{executionId}Status einer Ausführung abrufen
{
"executionId": "guid"
}AgentExecutionDto/api/agents/executions/{executionId}/cancelEine laufende Ausführung abbrechen
{
"executionId": "guid"
}{ message: string }/api/agents/executionsAusführungshistorie des Benutzers abrufen
{
"limit": "int (défaut: 20)"
}AgentExecutionDto[]// Exemple de connexion
const response = await fetch('https://api.zylopro.com/api/auth/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: 'user@example.com',
password: 'votre-mot-de-passe'
})
});
const data = await response.json();
// Stocker le token pour les requêtes ultérieures
const accessToken = data.token;// Exemple d'exécution d'un agent
const response = await fetch('https://api.zylopro.com/api/agents/proposalcraft/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${accessToken}`
},
body: JSON.stringify({
inputData: "Contenu de l'appel d'offres à analyser...",
metadata: {
projectName: "Étude satisfaction client 2025",
clientName: "ACME Corp"
}
})
});
const result = await response.json();
console.log('Exécution ID:', result.executionId);
console.log('Statut:', result.status);// Exemple de polling pour suivre une exécution
async function waitForCompletion(executionId, accessToken) {
while (true) {
const response = await fetch(
`https://api.zylopro.com/api/agents/executions/${executionId}`,
{
headers: { 'Authorization': `Bearer ${accessToken}` }
}
);
const execution = await response.json();
if (execution.status === 'Completed') {
return execution;
}
if (execution.status === 'Failed') {
throw new Error(execution.errorMessage);
}
// Attendre 2 secondes avant le prochain check
await new Promise(resolve => setTimeout(resolve, 2000));
}
}{
id: number
code: string
name: string
shortDescription: string
longDescription: string
category: string
inputType: string
outputType: string
monthlyPrice: number
includedExecutions: number
extraExecutionPrice: number
iconName: string
color: string
isActive: boolean
isBeta: boolean
isSubscribed: boolean
hasAccess: boolean
}{
id: guid
agentCode: string
agentName: string
status: "Pending" | "Running" |
"Completed" | "Failed" |
"Cancelled"
createdAt: datetime
startedAt: datetime | null
completedAt: datetime | null
durationSeconds: number | null
inputTokens: number | null
outputTokens: number | null
outputFilePath: string | null
errorMessage: string | null
}| HTTP-Code | Beschreibung |
|---|---|
| 200 | Erfolg |
| 400 | Ungültige Anfrage (fehlende oder falsche Parameter) |
| 401 | Nicht authentifiziert (fehlendes oder abgelaufenes Token) |
| 403 | Zugriff verweigert (unzureichende Berechtigungen) |
| 404 | Ressource nicht gefunden |
| 429 | Zu viele Anfragen (Rate-Limiting) |
| 500 | Interner Serverfehler |
{
"message": "Description de l'erreur",
"errors": {
"fieldName": ["Détail de l'erreur de validation"]
}
}Die API ist auf 100 Anfragen pro Minute pro Benutzer beschränkt. Die X-RateLimit-*-Header zeigen Ihren Kontingentstatus an.
Jeder Plan hat eine monatliche Ausführungsanzahl pro Agent. Prüfen Sie Ihr Dashboard, um Ihren Verbrauch zu verfolgen.
Unser technisches Team steht Ihnen bei der Integration der ZyloPro-API zur Verfügung.