API Synaptiik v1

Documentação da API pública

Aceda aos seus dados Synaptiik (projetos, sessões, clientes, faturas) a partir das suas ferramentas terceiras através de uma API REST protegida por Personal Access Token.

Autenticação

Todos os pedidos requerem um Personal Access Token (PAT) no cabeçalho Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Gere os seus tokens em Definições → API → Tokens de acesso.

URL base

https://synaptiik.fr/api/v1

Limite de pedidos

60 pedidos por minuto por token. Os cabeçalhos de resposta indicam a sua quota:

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

Endpoints

GET/api/v1/projectsprojects:read

Lista os projetos da sua organização com paginação.

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

Lista as sessões fotográficas com filtragem por projeto.

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

Lista a carteira de clientes com pesquisa por nome.

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

Lista os documentos financeiros (faturas, orçamentos, notas de crédito).

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

Especificação OpenAPI 3.1

Descarregue a especificação completa para a importar no Postman, Insomnia ou no seu cliente HTTP preferido.

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