Een API-key authenticeert je verzoeken aan de Simbase API. Elke key krijgt bij het aanmaken een set rechten, en die rechten liggen daarna vast. Eén key kan meerdere integraties bedienen, maar een aparte key per integratie is veiliger. Je maakt en beheert keys in het dashboard, onder Integrations → API.
Log in op dashboard.simbase.com.
Ga naar Integrations → API.
Klik op Create New API Key.
Geef de key een naam die zegt waar hij voor is, bijvoorbeeld Usage Guard Toolkit. De naam is alleen een label. Je ziet hem in je lijst met keys en nergens anders.
Stel onder Resources de rechten in die de key nodig heeft. Zie Rechten hieronder.
Klik op Create API Key en kopieer de key.
Bekijk de demo hieronder voor stapsgewijze instructies:
Rechten stel je per resource in, op een van drie niveaus. None betekent dat de key niet bij die resource kan. Dit is de standaard op elke rij. Read haalt gegevens op en wijzigt niets. Write maakt aan, wijzigt en verwijdert. Kies je Write, dan wordt Read op dezelfde rij ook geselecteerd, want alles wat schrijft moet eerst lezen.
Niet elke resource biedt alle drie. Account en Usage zijn alleen-lezen en tonen dus None en Read. SIM card state, Reset, Registration en Auto-disable zijn acties in plaats van gegevens, dus die tonen None en Write.
| Resource | Niveaus | Omvat |
|---|---|---|
All resources | None, Read, Write | Alle rijen hieronder tegelijk |
Account | None, Read | Je accountgegevens: organisatiegegevens, gebruikers en rollen, saldo |
Usage | None, Read | Gebruiksgegevens: data-, sms- en sessiegeschiedenis |
SIM cards | None, Read, Write | Alles in de groep SIM cards hieronder |
– SIM card details | None, Read, Write | Het SIM-record zelf: label, Tags, dekkingsplan, publiek IP-adres, gebruikslimieten en IMEI-lock |
– SIM card state | None, Write | SIM's in- en uitschakelen |
– Reset | None, Write | Verbinding resetten: de huidige datasessie stopt, zodat er een nieuwe kan starten |
– SMS | None, Read, Write | Berichtgeschiedenis lezen en berichten versturen |
– Registration | None, Write | Nieuwe SIM's op het account registreren |
– Auto-disable | None, Write | De Auto-disable-datum instellen en wissen |
Utilities | None, Read | Alles in de groep Utilities hieronder |
– Geo | None, Read | Cell ID-lookups: de mast waarmee een SIM verbonden is |
Integrations | None, Read, Write | Alles in de groep Integrations hieronder |
– Webhooks | None, Read, Write | Webhook-endpoints opvragen, aanmaken en verwijderen |
All resources
Account
Usage
SIM cards
– SIM card details
– SIM card state
– Reset
– SMS
– Registration
– Auto-disable
Utilities
– Geo
Integrations
– Webhooks
Naast SIM cards, Utilities en Integrations staat een pijltje. Klik erop om de afzonderlijke rechten eronder uit te klappen.
Een niveau op een bovenliggende rij geldt voor elke onderliggende rij, of het hoogste niveau dat die rij biedt. Zet je All resources op Write, dan krijgen Account en Usage Read, want meer ondersteunen ze niet.
Stel je alleen een onderliggende rij in, dan toont de bovenliggende rij niets. Dat is normaal. Een bovenliggende rij toont alleen een niveau als alle onderliggende rijen hetzelfde staan.
Geef zo weinig rechten als de integratie nodig heeft. Een key die alleen gebruik kan lezen, kan geen SIM uitschakelen als hij uitlekt.
| De integratie… | Instellen |
|---|---|
Rapporteert over dataverbruik | Usage: Read en SIM card details: Read |
Schakelt SIM's uit aan het eind van een bundel | SIM card state: Write |
Zet diefstalbeveiliging aan en uit | SIM card details: Write |
Stuurt sms'jes door of verstuurt ze | SMS: Write |
Registreert nieuwe SIM's | Registration: Write |
Draait de Usage Guard Toolkit | All resources: Write |
Rapporteert over dataverbruik
Schakelt SIM's uit aan het eind van een bundel
Zet diefstalbeveiliging aan en uit
Stuurt sms'jes door of verstuurt ze
Registreert nieuwe SIM's
Draait de Usage Guard Toolkit
In de API-referentie zie je deze terug als scopenamen, opgebouwd uit dezelfde boom. SIM card details wordt simcards.details:read en simcards.details:write.
Zet Show advanced settings aan voor twee optionele velden. Beide mag je leeg laten.
Beperkt de key tot één vertrouwd IP-adres of een bereik in CIDR-notatie. Verzoeken van andere adressen worden geweigerd. Laat het veld leeg voor geen beperking. De lijst met keys toont dan 0.0.0.0/0 onder Allowed IPs, wat elk adres betekent.
Het aantal dagen vanaf het aanmaken tot de key stopt met werken. Vul 31 in en de key verloopt over 31 dagen. Laat je het veld leeg, dan verloopt de key nooit.
Kortlevende keys zijn handig voor eenmalige migraties, toegang voor externe partijen en alles wat je anders zelf moet onthouden in te trekken.
De API-lijst toont elke key op het account: de naam, een ingekorte Key ID, het rechtenniveau waarmee hij is aangemaakt, wanneer hij voor het laatst is gebruikt en de IP-beperking. Last API call staat in de tijdzone van je account, en Allowed IPs toont 0.0.0.0/0 als er geen beperking is.
De Key ID is er alleen om keys uit elkaar te houden. Hij is ingekort en werkt niet voor authenticatie.
Rechten liggen vast bij het aanmaken en zijn daarna niet te wijzigen. Wil je aanpassen wat een key mag, maak dan een nieuwe key met de juiste rechten, zet je integratie over en verwijder de oude.
Het menu met drie puntjes aan het eind van elke rij heeft één optie: Delete. Een verwijderde key werkt direct niet meer en verzoeken met die key mislukken bij de authenticatie.
Stuur de key bij elk verzoek mee als bearer token:
Verzoek
GET /v2/simcards HTTP/1.1Host: api.simbase.comAuthorization: Bearer YOUR_API_KEY
Volledige documentatie van alle endpoints vind je op developer.simbase.com.
Nee. Rechten worden bij het aanmaken ingesteld en liggen daarna vast. Maak een vervangende key met de rechten die je nodig hebt, zet je integratie over en verwijder de oude key.
Nee. De volledige key zie je één keer, bij het aanmaken. De lijst toont alleen een ingekorte Key ID, en die werkt niet voor authenticatie. Verwijder de key en maak een nieuwe aan.
Dat de key geen IP-beperking heeft en verzoeken van elk adres accepteert. Dit krijg je als je het veld IP restrictions leeg laat.
Niets houdt je tegen om één key voor meerdere integraties te gebruiken, maar een key per integratie is die extra minuut waard. Zo geef je elke integratie alleen wat ze nodig heeft, zie je in de kolom Last API call welke nog in gebruik is, en kun je er één verwijderen of vervangen zonder de rest te breken. Een gedeelde key moet de rechten van iedereen samen dragen, en als je hem intrekt ligt alles tegelijk plat.
Webhooks: krijg events naar een URL van jezelf gestuurd, zonder de API te pollen
Usage Guard Toolkit (DIY): een kant-en-klare automatisering die een API-key met Write-rechten gebruikt
Diefstalbeveiliging: de scope simcards.details:write in de praktijk
Tijdzone van je account: bepaalt in welke tijdzone de kolom Last API call wordt getoond

