REST API voor ontwikkelaars

API REST is de interface waarmee u alle diensten kunt bedienen die u bij ons hebt gekocht.

Elke API-aanvraag moet worden geautoriseerd met behulp van de HTTP-header met de Bearer TOKEN.

Om de Tokens te beheren gaat u naar het gebruikersaccount in het Controlepaneel.
 

 

Het activeren van de interface API REST

Het activeren van de API is niet gekoppeld aan een account met speciale rechten. Maak en activeer eenvoudig wat een token in uw klantaccount wordt genoemd, of u kunt ook een nieuw account creëren.

U kunt een nieuw token creëren in het Controlepaneel in het gedeelte van de  Klanten Data.  daar vindt u de toegang tot de API beheer onderaan de pagina.

Het is mogelijk om meerdere  tokens te creëren, die kunnen worden gebruikt om REST aanvragen te autoriseren.

NOTITIE: Tokens kunnen niet worden beheerd of gemaakt vanuit een contactpersoon account. Het is altijd nodig om een "hoofd" bedrijfsaccount of een persoonlijk account te gebruiken.

 

Gedetailleerde Instructies:

  1. Met uw inloggegevens, opent u uw Controlepaneel. Als u uw inloggegevens niet meer weet kunt u een nieuw wachtwoord aanvragen.
  2. Rechtsboven, klikt u op de bedrijfsnaam / naam van de gebruiker. Als alternatief, kunt u de link van de API beheer  gebruiken en naar stap 4 gaan.                                                                                                                                                                                                                              
  3. Ga naar de onderkant van de pagina en klik op API.  U hebt nu toegang tot het API-beheer. 
  4. Klik op "Creëer een nieuw token". 
  5. In het optionele veld "opmerkingen" kunt u een beschrijving toevoegen die u helpt de verschillende tokens te onderscheiden.
  6. Stel een vervaldatum in, of laat het veld voor een onbepaalde tijd leeg.
  7. In de toegangsbeperking kunt u het IP adres opgeven van het apparaat dat is ingeschakeld voor de werking van het token. Als een apparaat met een ander IP-adres een token wil gebruiken, wordt niet voldaan aan de eisen en wordt het verzoek niet geautoriseerd.
  8. Zodra u alles hebt voltooid wat u nodig heeft, kunt u een nieuw token toevoegen. Hiervoor is het noodzakelijk om  het wachtwoord van uw klant account te bevestigen.

 

Het beheren van de Tokens

Het beheer van alle gemaakte tokens kan worden gedaan in het Controlepaneel

Hiervoor moet u de sectie De gegevens van uw klant account bewerken , onderaan de pagina de API-sectie openen. Om veiligheidsredenen, moet het wachtwoord van de klant account opnieuw worden ingevoerd.

Nadat u op  Details heeft geklikt,vindt u de opties om de beschrijving van het token te bewerken of de beperkingen ervan in te stellen, ofwel de vervaldatum of toegang toe te staan vanaf een specifiek IP-adres.

De beperking van het IP-adres werkt alleen voor een IP-adres of masker in de CIDR-notatie.  Als u de toegang tot verschillende adressen wilt beperken, moet u voor elk IP-adres een nieuw token configureren.

De gemaakte tokens kunnen op elk moment worden gedeactiveerd.Het uitschakelen van het token kan tot 10 minuten duren om effectief te zijn.

Uitgeschakelde tokens  kunnen niet volledig worden verwijderd, ze blijven geregistreerd in het account, zodat de gebruiker altijd kan achterhalen welke tokens in het verleden zijn gebruikt.

 

Ontwikkelingsomgeving - sandbox

Elke aanvraag die via de API wordt verzonden moet via de header worden geautoriseerd  HTTP HTAR Bearer TOKEN.      

Voordat u uw eigen token creëert, kunt u de testomgeving alleen op de server gebruiken via de beveiligde URL  https://sandboxapi.active24.com.Een geldig token voor deze sandbox-omgeving is 123456qwerty-ok.

De aanvragen in de sandbox omgeving brengen geen wijzigingen aan in het systeem of service, ze worden alleen gebruikt om de  geldigheid van de verzoeken te controleren.

De documentatie voor de ontwikkelaar omgeving is beschikbaar in https://sandboxapi.active24.com.


Productieomgeving en documentatie.

De productieomgeving van de API REST werkt alleen op de server via de beveiligde poort https://api.active24.com.

Voor de specificaties van alle methoden die beschikbaar zijn in de API, raadpleegt u de documentatie in https://api.active24.com.