Synaptiik API v1

Documentation API publique

Accédez à vos données Synaptiik (projets, shoots, clients, factures) depuis vos outils tiers via une API REST sécurisée par Personal Access Token.

Authentification

Toutes les requêtes requièrent un Personal Access Token (PAT) dans l'en-tête Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Générez vos tokens dans Paramètres → API → Tokens d'accès.

URL de base

https://synaptiik.fr/api/v1

Rate Limiting

60 requêtes par minute par token. Les en-têtes de réponse indiquent votre quota :

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

Endpoints

GET/api/v1/projectsprojects:read

Liste les projets de votre organisation avec pagination.

Paramètres : limit (max 100) · offset · status
GET/api/v1/shootsshoots:read

Liste les sessions de prise de vue avec filtrage par projet.

Paramètres : limit · offset · status · project_id
GET/api/v1/clientsclients:read

Liste le portefeuille clients avec recherche par nom.

Paramètres : limit · offset · search
GET/api/v1/invoicesinvoices:read

Liste les artifacts financiers (factures, devis, avoirs).

Paramètres : limit · offset · paid (true/false) · project_id

Spécification OpenAPI 3.1

Téléchargez la spec complète pour l'importer dans Postman, Insomnia ou votre client HTTP préféré.

Télécharger openapi.json

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