Documentatie voor ontwikkelaarsAPI v1

Aan de slag

Bouw op je werkruimte.

Verbind je tools met Squario via een JSON-API met versies. Ontdek het schema, lees je data en wijzig records met dezelfde rechten als in de app.

Eén API, je eigen werkruimte

De REST API gebruikt HTTPS en JSON. Een API-sleutel hoort bij één lid in één werkruimte. Je basis-URL eindigt al op /functions/v1/public-api/v1; kopieer die uit Instellingen → API en voeg het endpointpad uit deze gidsen toe. De documentatie staat op /docs, binnen de Squario-website.

  • Authenticeer met Authorization: Bearer <API_KEY>.
  • Een lijst bevat data en pagineringsinformatie in meta.
  • Een gelezen of geschreven record staat in een data-object.
  • Gebruik X-Request-Id om een verzoek te traceren.

De rechten volgen de sleutel

Elke operatie handelt als het lid dat de sleutel heeft aangemaakt. Lidmaatschap, resourcerechten en veldbeperkingen worden op de server gecontroleerd. De lees- en schrijftoegang, toegestane resources en toegestane IP-adressen van een sleutel kunnen die toegang beperken. Ze kunnen die niet uitbreiden.

REST API of MCP

Beide verbindingen gebruiken dezelfde actiekern voor resources. Kies REST voor een integratie die je zelf bestuurt, of MCP om een AI-client te verbinden met toestemming van het lid.

REST API of MCP
VerbindingInlogmiddelGeschikt voorVerbruik
REST APIAPI-sleutel van een lidServerintegraties, imports en synchronisatieMaandelijks API-verzoekenquotum
MCPOAuth 2.1-toestemmingExterne AI-clients en assistentenAI-credits van de werkruimte

Begin met lezen

Roep /me aan, ontdek de resources die je sleutel toestaat en beschrijf de resource die je nodig hebt. Het live schema bevat de beschikbare aangepaste velden van je werkruimte. De endpointreferentie beschrijft elke route en de schema’s van verzoeken en antwoorden.