API-sleutels en beveiliging
Scopes, IP-toegangslijsten, dagelijkse uitgavelimieten, vervaldatums, roteren zonder onderbreking en wat je doet als een sleutel is uitgelekt.
Op deze pagina
Een API-sleutel kan alles wat zijn scopes toestaan, betaald met je saldo. Behandel hem als een wachtwoord.
Vorm van de sleutel
Sleutels zien eruit als sgk_ gevolgd door 40 letters en cijfers. SmsGrab bewaart van elke sleutel alleen een vingerafdruk, dus een sleutel wordt één keer getoond, bij het maken of roteren, en daarna nooit meer. In je account zie je alleen het begin en de laatste vier tekens.
Beperk wat elke sleutel kan
Bij het maken of bewerken van een sleutel kun je hem beperken:
| Instelling | Wat het doet |
|---|---|
| Scopes | read voor saldo, catalogus, prijzen, activeringen en gebruik; read en purchase om ook te kopen, te annuleren en af te ronden |
| IP-toegangslijst | Maximaal 50 IPv4- of IPv6-adressen of CIDR-bereiken; verzoeken van andere adressen worden geweigerd |
| Dagelijkse uitgavelimiet | Het maximum dat deze sleutel (netto) per UTC-dag mag uitgeven; daarboven worden aankopen geweigerd en wordt er niets afgeschreven |
| Vervaldatum | Een optionele datum waarna de sleutel niet meer werkt, maximaal 2 jaar vooruit |
Gebruik één sleutel per applicatie of server, met de kleinste scopes die nodig zijn. Een account kan maximaal 10 actieve sleutels hebben.
Gevoelige wijzigingen bevestigen
Een sleutel maken, roteren, een webhook toevoegen, een webhookgeheim vernieuwen en een sleutel versoepelen (meer scopes, een ruimere IP-lijst, een hogere limiet of een latere vervaldatum) vragen opnieuw om je wachtwoord, plus je code voor verificatie in twee stappen als die aanstaat. De bevestiging blijft 5 minuten geldig. Een sleutel intrekken en de limieten aanscherpen vragen daar nooit om.
Roteren zonder onderbreking
Roteren geeft een sleutel een nieuw geheim en houdt de instellingen, het gebruik en de webhooks. Je kiest een overgangsperiode van maximaal 72 uur waarin het oude geheim nog werkt, zodat je je servers zonder onderbreking kunt bijwerken.
Intrekken
Intrekken stopt een sleutel meteen en definitief. Zijn webhooks worden ook uitgezet.
Als een sleutel is uitgelekt
- Trek hem in, of roteer hem met een overgangsperiode van 0 uur.
- Controleer het verzoeklogboek van de sleutel (laatste 7 dagen) en je Portemonnee op activiteit die je niet herkent.
- Maak een nieuwe sleutel met een IP-toegangslijst en een dagelijkse uitgavelimiet.
Wat we loggen
Sleutels komen nooit in een logboek terecht. Per verzoek bewaren we 7 dagen de tijd, de route, de status, de duur en een verzoek-id, en je kunt ze per sleutel bekijken. Sleutels maken, roteren en intrekken verschijnt ook in je accountactiviteit, en elke nieuwe sleutel geeft een melding.
Nooit vanuit een browser
De API accepteert geen aanroepen vanuit webpagina's (er is geen CORS). Roep hem alleen aan vanaf je eigen servers.
Was dit artikel nuttig?
Bedankt! Fijn dat het hielp.