Synaptiik API v1

Documentatie publieke API

Krijg toegang tot uw Synaptiik-gegevens (projecten, shoots, klanten, facturen) vanuit uw externe tools via een REST-API die beveiligd is met een Personal Access Token.

Authenticatie

Alle verzoeken vereisen een Personal Access Token (PAT) in de header Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Genereer uw tokens in Instellingen → API → Toegangstokens.

Basis-URL

https://synaptiik.fr/api/v1

Snelheidsbeperking

60 verzoeken per minuut per token. De responsheaders geven uw quotum aan:

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

Endpoints

GET/api/v1/projectsprojects:read

Toont de projecten van uw organisatie met paginering.

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

Toont de shootsessies met filtering op project.

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

Toont het klantenbestand met zoeken op naam.

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

Toont de financiële documenten (facturen, offertes, creditnota's).

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

OpenAPI 3.1-specificatie

Download de volledige specificatie om te importeren in Postman, Insomnia of uw favoriete HTTP-client.

openapi.json downloaden

SDK's

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