Synaptiik API v1

Dokumentation der öffentlichen API

Greifen Sie über eine mit Personal Access Token gesicherte REST-API von Ihren Drittanbieter-Tools aus auf Ihre Synaptiik-Daten zu (Projekte, Shootings, Kunden, Rechnungen).

Authentifizierung

Alle Anfragen erfordern einen Personal Access Token (PAT) im Header Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Erstellen Sie Ihre Tokens unter Einstellungen → API → Zugriffstokens.

Basis-URL

https://synaptiik.fr/api/v1

Rate Limiting

60 Anfragen pro Minute pro Token. Die Antwort-Header zeigen Ihr Kontingent an:

X-RateLimit-Limit
60
X-RateLimit-Remaining
58
X-RateLimit-Reset
1714300860

Endpunkte

GET/api/v1/projectsprojects:read

Listet die Projekte Ihrer Organisation mit Paginierung auf.

Parameter: limit (max 100) · offset · status
GET/api/v1/shootsshoots:read

Listet Shooting-Sessions mit Filterung nach Projekt auf.

Parameter: limit · offset · status · project_id
GET/api/v1/clientsclients:read

Listet den Kundenstamm mit Namenssuche auf.

Parameter: limit · offset · search
GET/api/v1/invoicesinvoices:read

Listet Finanzdokumente (Rechnungen, Angebote, Gutschriften) auf.

Parameter: limit · offset · paid (true/false) · project_id

OpenAPI 3.1-Spezifikation

Laden Sie die vollständige Spezifikation herunter, um sie in Postman, Insomnia oder Ihren bevorzugten HTTP-Client zu importieren.

openapi.json herunterladen

SDKs

JavaScript / TypeScript
npm install @synaptiik/sdk
import { SynaptiikClient } from '@synaptiik/sdk';
const client = new SynaptiikClient({ token: 'syn_live_...' });
const { data } = await client.projects.list();
Python
pip install synaptiik
from synaptiik import SynaptiikClient
client = SynaptiikClient(token="syn_live_...")
projects = client.projects.list()
PHP
composer require synaptiik/sdk
use Synaptiik\Client;
$client = new Client(['token' => 'syn_live_...']);
$projects = $client->projects()->list();