Solarware API-Dokumentation
YAML herunterladen

Solarware API

Öffentliche REST-API v1 von Solarware (mail-service `/api/v1` → Solarware `/api/v3/external`). Authentifizieren Sie jede Anfrage mit dem Header `X-Api-Key: {your_api_key}` (auch akzeptiert: `X-API-KEY` oder Query-Parameter `?api_key=`). Kontakte & Partner nutzen verschachtelte CRM-Arrays (`addresses`, `emails`, `phones`). Veraltete flache Partner-Felder (`street`, `email`, `telefone`, …) werden nicht akzeptiert. Listen unterstützen `search` über Entity- und CRM-Felder sowie `page` / `per_page`. Create-Endpunkte akzeptieren optional `Idempotency-Key` für sichere Retries (Make/Zapier/n8n).

Basis-URL

/api/v1 Öffentliche API v1 Basispfad

Version 1.8.0

Authentifizierung

ApiKeyAuth apiKey

Ihr Solarware API-Schlüssel.

Die Standard-Authentifizierung gilt für alle Endpunkte, sofern nicht anders angegeben.

Endpunkt-Gruppen

2
Länder
Länderverzeichnis (nutzen Sie `id` als `countries_id` bei Adressen).
 2
Einheiten
Einheitenverzeichnis (nutzen Sie `id` als `unit_id` bei Produkten).
 2
Kategorien
Produktkategorien (nutzen Sie `id` als `categories_id` bei Produkten).
 2
Anreden
Anredenverzeichnis (nutzen Sie `id` als `salutations_id` bei Kontakten).
 2
Titel
Titelverzeichnis (nutzen Sie `id` als `titles_id` bei Kontakten).
 2
Tags
Deal-Tags (nutzen Sie `id` als `tags_id` bei Deals).
 6
Kontakte
Kontakte mit CRM-Details und top-level /addresses /emails /phones.
 6
Partner
Partner mit CRM-Details und top-level /addresses /emails /phones.
 6
Adressen
Top-level CRM-Adressen. Create/List mit genau einem von contacts_id oder partners_id.
 6
E-Mails
Top-level CRM-E-Mails. Create/List mit genau einem von contacts_id oder partners_id.
 6
Telefone
Top-level CRM-Telefone. Create/List mit genau einem von contacts_id oder partners_id.
 10
Produkte
Katalogprodukte (Name, Preise, Bestand, optional categories_id / unit_id). Titelbild über POST /products/{id}/image, Galerie über POST /products/{id}/files.
 6
Angebote
Verkaufsangebote.
 6
Verträge
Verkaufsverträge.
 6
Rechnungen
Verkaufsrechnungen.
 1
Pipelines
Deal-Pipelines inkl. Phasen (phase id als phase_id beim Deal-Create).
 9
Deals
Deals. Beim Erstellen können bestehende Kontakt-/Partner-IDs oder verschachtelte Objekte übergeben werden. Update/Delete/Phasenwechsel über /deals/{id} und POST /deals/{id}/move. Feldwerte lesen und aktualisieren über GET und POST /deals/fields.
 6
Aufgaben
Deal-Aufgaben. Optional deals_id; type other/call/email; status to-do/done.
 6
Notizen
Deal-Notizen. Create erfordert deals_id.
 6
Solarstandorte
Solaranlagen-Standorte (Name, Adresse, Status).