API-Dokumentation

Integrieren Sie AuxScale nahtlos in Ihre bestehende Software-Landschaft mit unserer umfassenden REST API.

API-Key generierenPostman Collection
REST
API Standard
99.9%
Uptime SLA
< 200ms
Ø Response Time
4
SDKs verfügbar

Erste Schritte

1. Authentifizierung

Alle API-Anfragen erfordern einen Bearer Token, den Sie in Ihrem Dashboard unter "Einstellungen → API" generieren können.

# Authentifizierung Header
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

2. Basis-URL

Alle API-Endpunkte sind über unsere Basis-URL erreichbar. Verwenden Sie immer HTTPS für sichere Übertragung.

# Basis-URL
https://api.auxscale.com/v1/
# Beispiel-Request
GET https://api.auxscale.com/v1/leads

API-Endpunkte

GET/api/v1/leadsAlle Leads abrufen

Parameter:

  • limit
  • offset
  • status
  • assigned_to

Authentifizierung:

Bearer Token

Response:

"leads": "Array of lead objects",
"total": "Total count",
"page": "Current page"
POST/api/v1/leadsNeuen Lead erstellen

Parameter:

  • first_name
  • last_name
  • email
  • phone
  • source

Authentifizierung:

Bearer Token

Response:

"id": "Lead ID",
"status": "Created status",
"message": "Success message"
PUT/api/v1/leads/{id}Lead aktualisieren

Parameter:

  • Any lead field

Authentifizierung:

Bearer Token

Response:

"id": "Lead ID",
"updated_fields": "Array of updated fields",
"message": "Success message"
GET/api/v1/pipelinePipeline-Status abrufen

Parameter:

  • date_from
  • date_to
  • user_id

Authentifizierung:

Bearer Token

Response:

"stages": "Array of pipeline stages",
"metrics": "Pipeline metrics",
"conversion_rates": "Stage conversion rates"
POST/api/v1/emails/sendE-Mail über AuxScale versenden

Parameter:

  • to
  • subject
  • template_id
  • variables

Authentifizierung:

Bearer Token

Response:

"email_id": "Email tracking ID",
"status": "Send status",
"scheduled_at": "Send time"
GET/api/v1/reports/dashboardDashboard-Daten abrufen

Parameter:

  • period
  • metrics

Authentifizierung:

Bearer Token

Response:

"overview": "Overview metrics",
"charts": "Chart data",
"kpis": "Key performance indicators"

SDKs & Libraries

🟨

JavaScript/Node.js

@auxscale/api-clientv2.1.4
TypeScript Support
Async/Await
Error Handling
Auto-retry
🐍

Python

auxscale-pythonv1.8.2
Pandas Integration
Type Hints
Data Classes
Bulk Operations
🐘

PHP

auxscale/php-sdkv1.5.1
Laravel Support
PSR-4 Compliant
Composer Ready
Unit Tests
💜

C# / .NET

AuxScale.ApiClientv1.3.0
.NET Core 6+
Async Methods
Strong Types
Dependency Injection

Code-Beispiele

Lead erstellen (JavaScript)

// Neuen Lead erstellen
const response = await fetch(
'https://api.auxscale.com/v1/leads',
{
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: 'Max',
last_name: 'Mustermann',
email: 'max@example.com',
phone: '+49 123 456789',
source: 'website'
})
}
);

Pipeline-Daten abrufen (Python)

# Pipeline-Status abrufen
import requests
headers = {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
}
response = requests.get(
'https://api.auxscale.com/v1/pipeline',
headers=headers,
params={
'date_from': '2024-01-01',
'date_to': '2024-12-31'
}
)
data = response.json()

Webhooks

Real-time Benachrichtigungen

Webhooks ermöglichen es Ihnen, real-time Benachrichtigungen über Ereignisse in AuxScale zu erhalten. Konfigurieren Sie Ihre Webhook-URL in den Einstellungen und erhalten Sie HTTP-POST-Anfragen für relevante Events.

⚡

Real-time

Ereignisse werden sofort an Ihre URL gesendet

🔒

Secure

HMAC-SHA256 Signatur für Authentifizierung

🔄

Reliable

Automatische Wiederholung bei Fehlern

Verfügbare Events

lead.created

Wird ausgelöst wenn ein neuer Lead erstellt wird

Payload enthält:
lead_idsourceassigned_tocreated_at
lead.updated

Wird ausgelöst wenn ein Lead aktualisiert wird

Payload enthält:
lead_idchanged_fieldsprevious_valuesupdated_at
pipeline.moved

Wird ausgelöst wenn ein Lead die Pipeline-Stage wechselt

Payload enthält:
lead_idfrom_stageto_stagemoved_bymoved_at
email.sent

Wird ausgelöst wenn eine E-Mail versendet wurde

Payload enthält:
email_idrecipienttemplate_idsent_at
commission.calculated

Wird ausgelöst wenn eine Provision berechnet wurde

Payload enthält:
deal_idamountrecipientcalculation_date

Rate Limits & Best Practices

API-Limits

  • • Standardplan: 1.000 Requests/Stunde
  • • Businessplan: 5.000 Requests/Stunde
  • • Enterprise: Unlimited (Fair Use)
  • • Burst-Limit: 100 Requests/Minute

Best Practices

  • • Implementieren Sie Exponential Backoff
  • • Verwenden Sie Bulk-Operationen wenn möglich
  • • Cachen Sie Responses wo sinnvoll
  • • Überwachen Sie Rate-Limit Headers

Benötigen Sie Hilfe bei der Integration?

Unser Developer-Support-Team hilft Ihnen gerne bei der Integration der AuxScale API in Ihre Anwendung.

Developer SupportIntegration Workshop buchen