API-sleutels
SMS versturen vanuit uw eigen applicaties met een SMS-API-sleutel.
Met een API-sleutel kan een applicatie van uw bedrijf (reservatiesoftware, een website, een interne tool) SMS versturen zonder het verzendscherm van One te gebruiken. SMS die zo worden verstuurd, verschijnen in de Geschiedenis.
U beheert de sleutels in SMS › Instellingen, blok Integraties, onderdeel Integraties.
Alleen voor beheerders
Deze pagina is voorbehouden aan de eigenaar en de beheerders van de account, en aan de gebruikers met niveau Admin in SMS.
SMS-API-sleutel of token van de One-API?
Dat zijn twee verschillende zaken. De SMS-API-sleutel die hier wordt beschreven, dient alleen voor het SMS-verzendadres dat op deze pagina staat. De tokens van de One-API, aangemaakt in de accountinstellingen, geven toegang tot de andere modules (zie Accountinstellingen). Het ene vervangt het andere niet.
Een sleutel aanmaken
Klik in het blok API Sleutels op Sleutel aanmaken.
Geef een Sleutelnaam waaraan u de applicatie herkent die hem gebruikt, bijvoorbeeld "Website". Klik op Aanmaken.
Het venster API Sleutel aangemaakt toont de volledige sleutel. Klik op Kopiëren en plak hem in uw applicatie.
Kopieer de sleutel meteen
De volledige sleutel wordt maar één keer getoond. Zodra het venster gesloten is, toont One alleen nog het begin ervan. Bent u de sleutel kwijt, verwijder hem dan en maak een nieuwe aan.
Met een sleutel kunt u SMS versturen in naam van uw bedrijf: behandel hem als een wachtwoord.
Uw sleutels opvolgen
Elke sleutel toont zijn naam, zijn status Actief of Inactief, het begin van de sleutel, de aanmaakdatum (Aangemaakt op) en Laatst gebruikt.
- Een sleutel deactiveren: zet de schakelaar op de regel om. De applicatie die hem gebruikt, kan geen SMS meer versturen tot u de sleutel opnieuw activeert.
- Een sleutel verwijderen: klik op het prullenbakicoon en daarna op Verwijderen in het venster API Sleutel verwijderen. De verwijdering is definitief.
Deactiveer liever als u de toegang maar even wilt afsluiten.
De ingebouwde documentatie
Onder de sleutels geeft het blok API Documentatie uw ontwikkelaar alles wat nodig is om zijn applicatie te koppelen:
- Endpoint: het adres dat moet worden aangeroepen, met een knop om het te kopiëren;
- Parameters: de velden die moeten worden verstuurd;
- Codevoorbeelden: in cURL, JavaScript, PHP en Python;
- Antwoord: een voorbeeld van een antwoord.
De sleutel wordt meegegeven in de header X-API-Key van de aanvraag.
| Parameter | Verplicht | Inhoud |
|---|---|---|
to | Ja | Het nummer van de ontvanger in internationaal formaat, of een lijst van nummers. |
message | Ja | De tekst van de SMS. |
from | Nee | De afzendernaam. Ontbreekt die, dan wordt de standaardafzender uit de Instellingen gebruikt. |