API de Synaptiik v1

Documentación de la API pública

Accede a tus datos de Synaptiik (proyectos, sesiones, clientes, facturas) desde tus herramientas externas mediante una API REST protegida por un token de acceso personal.

Autenticación

Todas las solicitudes requieren un token de acceso personal (PAT) en la cabecera Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Genera tus tokens en Ajustes → API → Tokens de acceso.

URL base

https://synaptiik.fr/api/v1

Límite de solicitudes

60 solicitudes por minuto por token. Las cabeceras de respuesta indican tu cuota:

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

Endpoints

GET/api/v1/projectsprojects:read

Lista los proyectos de tu organización con paginación.

Parámetros: limit (max 100) · offset · status
GET/api/v1/shootsshoots:read

Lista las sesiones de fotos con filtrado por proyecto.

Parámetros: limit · offset · status · project_id
GET/api/v1/clientsclients:read

Lista la cartera de clientes con búsqueda por nombre.

Parámetros: limit · offset · search
GET/api/v1/invoicesinvoices:read

Lista los documentos financieros (facturas, presupuestos, abonos).

Parámetros: limit · offset · paid (true/false) · project_id

Especificación OpenAPI 3.1

Descarga la especificación completa para importarla en Postman, Insomnia o tu cliente HTTP preferido.

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