Je eerste API-verzoek

De verbinding voorbereiden#

Kies in Squario je werkruimte en open Instellingen → API → Sleutels. API-toegang vereist een geschikt abonnement en het recht api.access. Eigenaars en beheerders hebben dat recht standaard.

• Maak een benoemde sleutel aan met een verplichte vervaldatum en alleen de toegang en resources die je integratie nodig heeft.
• Kopieer het geheim wanneer het wordt getoond. Je kunt het later niet opnieuw opvragen.
• Kopieer de basis-URL uit de verbindingsgegevens. Behoud het achtervoegsel /v1.
• Bewaar de sleutel in de geheimenbeheerder of omgeving van je server. Begin met een sleutel die alleen kan lezen.

read -r -p 'API base URL from Settings → API: ' SQUARIO_API_BASE
SQUARIO_API_BASE="${SQUARIO_API_BASE%/}"
read -r -s -p 'API key: ' SQUARIO_API_KEY
printf '\n'
export SQUARIO_API_BASE SQUARIO_API_KEY

Je identiteit controleren#

Deze voorbeelden gebruiken SQUARIO_API_BASE voor de gekopieerde basis-URL en SQUARIO_API_KEY voor het geheim. Stel beide in je lokale omgeving in. /me geeft sleutelmetadata, je werkruimte en lid terug, plus de actuele quota en snelheidslimieten. Het geheim wordt nooit teruggegeven.

curl --fail-with-body "$SQUARIO_API_BASE/me" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

const base = process.env.SQUARIO_API_BASE?.replace(/\/$/, "");
const key = process.env.SQUARIO_API_KEY;
if (!base || !key) throw new Error("Set SQUARIO_API_BASE and SQUARIO_API_KEY");

const response = await fetch(`${base}/me`, {
  headers: { Authorization: `Bearer ${key}` },
  signal: AbortSignal.timeout(30_000),
});
const body = await response.json();
if (!response.ok) {
  throw new Error(`${body.error.code}: ${body.error.message} (${body.error.request_id})`);
}
console.log(body.data);

import json
import os
from urllib.request import Request, urlopen

base = os.environ["SQUARIO_API_BASE"].rstrip("/")
key = os.environ["SQUARIO_API_KEY"]
request = Request(f"{base}/me", headers={"Authorization": f"Bearer {key}"})
with urlopen(request, timeout=30) as response:
    body = json.load(response)
print(body["data"])

Een resource en schema vinden#

/resources geeft catalogusitems met key, label, read_only, searchable en requires_model_id. De catalogus is gefilterd op de toegestane resources van de sleutel; resourcerechten worden nog steeds gecontroleerd bij datatoegang. Beschrijf een resource voordat je op velden vertrouwt of records schrijft.

curl --fail-with-body "$SQUARIO_API_BASE/resources" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

curl --fail-with-body "$SQUARIO_API_BASE/resources/companies" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

Het contract zonder sleutel bekijken#

De versieroot en /openapi.json zijn openbaar. Hiermee identificeer je de API en haal je het OpenAPI 3.1-contract op. Deze oproepen verbruiken geen quotum van je werkruimte. De kopie in deze documentatie is een releaseopname; het document van de uitgerolde API weerspiegelt die uitrol.

curl --fail-with-body "$SQUARIO_API_BASE"
curl --fail-with-body "$SQUARIO_API_BASE/openapi.json"

Je integratie betrouwbaar maken#

Ga verder met filters en paginering voor leesoperaties, of veilige wijzigingen voor aanmaken en bijwerken. Lees de foutengids voordat je automatische retries toevoegt. Gebruik Idempotency-Key voor herhaalde schrijfverzoeken en respecteer Retry-After.