Aan de slag
Authenticatie en toegang
Begrijp sleutels van leden, werkruimtebegrenzing, beperkingen, vervaldatums en veilig vernieuwen.
Een bearer-sleutel meesturen
Geauthenticeerde endpoints accepteren Authorization: Bearer <API_KEY>. Sleutels beginnen met sqk_, gevolgd door 64 hexadecimale tekens. Een sleutel is gebonden aan de eigenaar en werkruimte; je kiest geen werkruimte in het verzoek.
- Gebruik de sleutel op je server. Deze API stuurt geen CORS-headers.
- Zet een sleutel nooit in browser-JavaScript, een URL, broncodebeheer of een openbaar log.
- Gebruik HTTPS en afzonderlijke sleutels voor ontwikkeling en productie.
De integratie begrenzen
Kies beperkingen wanneer je een sleutel aanmaakt. Ze gelden boven op de actuele rechten van de eigenaar.
| Beperking | Gedrag |
|---|---|
| Toegang | read of write (lezen en schrijven). POST /query is een leesoperatie. |
| Resources | Een expliciete lijst of alle catalogusresources. Relaties vereisen toegang tot beide kanten. |
| IP-adressen | Optionele IP/CIDR-lijst voor de uitgaande adressen van je server. |
| Vervaldatum | Verplicht. De app biedt een levensduur van maximaal één jaar. |
Vernieuwen en intrekken
Het geheim wordt één keer getoond; Squario slaat een hash op. Maak een vervangende sleutel, werk het geheim van je integratie bij, controleer met /me en trek de oude sleutel in onder Instellingen → API. Geef sleutels de naam van de integratie om verbruik en wijzigingen te herkennen.
- Verlopen en ingetrokken sleutels werken niet meer.
- Het wegnemen van API-rechten of wijzigen van het abonnement kan een bestaande sleutel onmiddellijk stoppen.
- Wanneer een lidmaatschap inactief wordt, worden de sleutels ingetrokken. Opnieuw activeren herstelt die niet.
- Vervaldatumherinneringen zijn gepland op 14 en 3 dagen vooraf, afhankelijk van notificatievoorkeuren en de levensduur van de sleutel.
Wanneer MFA verandert
Een sleutel delegeert het authenticatieniveau van de sessie waarin die is gemaakt. Als een nieuw geverifieerde MFA-factor dat niveau verouderd maakt, antwoorden verzoeken met 401 key_assurance_stale. Meld je opnieuw aan met recente MFA en maak een vervangende sleutel.
API-toegang en beheer
Met api.access kunnen leden hun eigen sleutels maken en gebruiken. Met api.manage kunnen beheerders sleutels van leden bekijken en intrekken en werkruimtebreed verbruik inspecteren. API-toegang is beschikbaar op Pro, Growth, Scale en Enterprise. Rechten en abonnement worden bij elk verzoek opnieuw gecontroleerd.