API Synaptiik v1

Documentazione dell'API pubblica

Accedi ai tuoi dati Synaptiik (progetti, shooting, clienti, fatture) dai tuoi strumenti terzi tramite un'API REST protetta da Personal Access Token.

Autenticazione

Tutte le richieste richiedono un Personal Access Token (PAT) nell'header Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Genera i tuoi token in Impostazioni → API → Token di accesso.

URL di base

https://synaptiik.fr/api/v1

Limitazione delle richieste

60 richieste al minuto per token. Gli header di risposta indicano la tua quota:

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

Endpoint

GET/api/v1/projectsprojects:read

Elenca i progetti della tua organizzazione con paginazione.

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

Elenca le sessioni di shooting con filtro per progetto.

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

Elenca il portafoglio clienti con ricerca per nome.

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

Elenca i documenti finanziari (fatture, preventivi, note di credito).

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

Specifica OpenAPI 3.1

Scarica la specifica completa per importarla in Postman, Insomnia o il tuo client HTTP preferito.

Scarica openapi.json

SDK

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