API-keys aanmaken en beheren in Simbase

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.

API-key aanmaken

  1. Log in op dashboard.simbase.com.

  2. Ga naar Integrations → API.

  3. Klik op Create New API Key.

  4. 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.

  5. Stel onder Resources de rechten in die de key nodig heeft. Zie Rechten hieronder.

  6. Klik op Create API Key en kopieer de key.

Kopieer de key meteenSimbase toont de key één keer, in het venster "Keep your key safe". Klik op de key om hem te kopiëren en bewaar hem in een wachtwoordmanager of in de secrets store van je platform. Ben je hem kwijt, dan kun je hem niet meer opvragen. Verwijder de key dan en maak een nieuwe aan.

Bekijk de demo hieronder voor stapsgewijze instructies:

Rechten

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.

De resourceboom

Resource
  • All resources

  • Account

  • Usage

  • SIM cards

  • – SIM card details

  • – SIM card state

  • – Reset

  • – SMS

  • – Registration

  • – Auto-disable

  • Utilities

  • – Geo

  • Integrations

  • – Webhooks

Bovenliggende en onderliggende rijen

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.

Een niveau kiezen

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…
  • 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.

Geavanceerde instellingen

Zet Show advanced settings aan voor twee optionele velden. Beide mag je leeg laten.

IP restrictions

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.

Alleen vaste adressenGebruik een IP-beperking als de integratie vanaf een vast adres draait, zoals je eigen server of een NAT-gateway. Gehoste automatiseringsplatforms zoals Make.com en Zapier gebruiken wisselende adressen, dus een IP-beperking laat ze vastlopen.

Expires in (number of days)

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.

Je keys beheren

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.

De key gebruiken

Stuur de key bij elk verzoek mee als bearer token:

Verzoek

GET /v2/simcards HTTP/1.1
Host: api.simbase.com
Authorization: Bearer YOUR_API_KEY

Volledige documentatie van alle endpoints vind je op developer.simbase.com.

Veelgestelde vragen

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.

Gerelateerd