Authenticatie

De Incasso.io API biedt authenticatie met API-sleutels. Een API sleutel is uniek en zorgt er voor dat alleen jij verbinding kunt maken met je administratie.

API-sleutels maken ¶

Het eerste dat je nodig hebt, is een actieve administratie. Elke administratie heeft een twee unieke API-sleutels: een Live API-Sleutel en een Test API-Sleutel.

Tijdens het bouwen en testen van jouw integratie, moet je de Test API-sleutel gebruiken . Zodra je klaar bent om echte gegevens te verwerken, vervang je de sleutel foor je Live API-Sleutel

Het is natuurlijk erg belangrijk om eventuele API-sleutels veilig te houden . Deel ze nooit. Als een sleutel echter lekt, kunt u deze altijd opnieuw laten genereren . Vergeet niet om nieuwe sleutels toe te passen op uw code.

Verificatie van een API-aanroep ¶

De API-sleutel of -token moet met elk API-verzoek worden meegestuurd door deze met Authorization behulp van de Bearermethode in de header van de HTTP-aanroep op te geven . Bijvoorbeeld: een geldige Authorization header is test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM.

In het onderstaande voorbeeld gebruiken we een Test API-sleutel voor de GETmethode van de cases resource . Deze methode haalt een incassozaak op - in dit geval de betaling met de fictieve ID cs_WDqYK6vllg.

curl -X GET https://api.incasso.io/v2/cases/cs_WDqYK6vllg \
    -H "Authorization: test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

Het antwoord zal zijn in JSON.

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
        "resource": "case",
        "id": "cs_7UhSN1zuXS",
        "casenumber":"20100315",
        "url":"https://app.incasso.io/cs/cs_WDqYK6vllg",
        "status":"SOM1",
        "InvoiceTotal":"480.00",
        "CostTotal":"50.00",
        "Paid":"200.00",
        "Balance":"330.00",
        "Cleared":"50.00",
        "Available":"100.00",
        "Created":"30-10-2020",
        "LastAction":"1e sommatie verzonden",
        "LastActionDate":"15-11-2020",
        "NextAction":"Beoordeling dossier door incassospecialist",
        "NextActionDate":"02-12-2020"
}

Webkey

Om directe links, zonder tussenkomst van een inlogscherm beschikbaar te maken vanuit je administratie kan je gebruikmaken van een webkey. Om veiligheidsredenen staat deze webkey los van de apikey en kan alleen gebruikt worden om data te lezen. Standaard staat de webkey uit, maar deze kan in het portaal worden geactiveerd.

Om een incassozaak rechtstreek te benaderen dient de geactiveerde webkey te worden toegevoegd aan de url van het dossier.

https://portaal.incasso.io/cs/{webkey}/cs_WDqYK6vllg