thumb_up
thumb_down
link
Copy link
Copied
insert_emoticon
lmatfy
Copied

Connector - externe software koppelen met Profit (API)

AFAS beschikt over een krachtige API waarmee je koppelingen kunt maken tussen AFAS en andere applicaties. Deze pagina helpt je op weg met het gebruik en beheer van de API.

Inhoud

AFAS API

Heb je nog niet eerder gebruik gemaakt van de AFAS API?

Lees deze informatie dan nauwkeurig

App Connector - authenticatie

Via de App Connector stel je de toegang in voor de endpoints. Om een app te verbinden met AFAS Profit maak je een nieuwe AppConnector aan en genereer je een token. Deze token gebruik je in het request. Neem deze artikelen door voor het instellen en alle mogelijkheden:

GetConnector - data ophalen

Om data op te halen via AFAS maak je gebruik van GetConnectoren. Dit zijn datadefinities die je zelf kunt maken. De data wordt in JSON, XML of CSV als response gegeven. Doordat je zelf de GetConnectoren kunt maken zijn de mogelijkheden heel groot. Gebruik deze links voor het aanmaken, authenticatie en testen:

UpdateConnector - data aanmaken, aanpassen en verwijderen

Met UpdateConnectoren kun je data in Profit toevoegen, aanpassen en verwijderen. Het bericht dat je naar deze endpoints stuurt wordt gevalideerd en als het bericht voldoet aan de eisen krijg je een response.

Response meldingen bij gebruik Connectoren

Bij het gebruik van de AFAS API geven de GetConnectoren en UpdateConnectoren altijd een response. Je krijgt deze response als het proces op de AFAS server is afgerond. De data is bijvoorbeeld opgehaald of de invoer is volledig verwerkt. Ook krijg je altijd een response als er een fout optreedt of de service niet beschikbaar is.

HTTP staat voor Hypertext Transfer Protocol. Dit is een reeks aan regels en afspraken op basis waarvan informatie via internet wordt uitgewisseld.

Success responses

Wanneer je verbinding maakt met de AFAS API en je krijgt een response in de HTTP 200 range dan weet je dat je request gelukt is.

  • HTTP 200: De GetConnector heeft succesvol data opgehaald of de UpdateConnector is succesvol uitgevoerd
  • HTTP 201: De UpdateConnector is uitgevoerd en er is een response body toegevoegd met bijvoorbeeld het ID van de aangemaakte regel

Error Responses

  • HTTP 401 betekent dat je niet geauthentiseerd bent om verbinding te maken. Er zijn meerdere mogelijke redenen waarom je deze error krijgt:
    • Verkeerde URL of webservice adres
    • GetConnector of UpdateConnector is niet toegevoegd aan de AppConnector
    • Token is verlopen
  • HTTP 400 geeft aan dat de request die je doet niet volgens de afspraken is. Je geeft bijvoorbeeld geen Get/Post/Put/Delete parameter mee aan je request
  • HTTP 500 geeft aan dat er verbinding gemaakt wordt met AFAS maar dat de request inhoudelijk wordt afgekeurd. Dit zijn inhoudelijk meldingen waarbij je in de response een bericht krijgt met beknopte uitleg en een verwijzing naar het Profit logboek. Dit logboek geeft diepgaande informatie over de foutmelding. Zie ook: https://help.afas.nl/help/NL/SE/App_Cnnctr_Update_035.htm
  • HTTP 503 Wanneer de webservice niet beschikbaar is, bijvoorbeeld door onderhoud of een verstoring, krijg je deze response. Meestal kun je met een retry de request opnieuw uitvoeren en wordt deze wel goed behandeld. Zie hierbij ook afasstatus.nl

REST API

Via de REST API kun je data uitwisselen met AFAS in JSON formaat. Hiervoor maak je gebruik van een authenticatie header met het token in Base64.

Meer informatie:

SOAP API

De AFAS SOAP API maakt gebruik van uitwisseling via XML.

Meer informatie:

Speciale connectoren

Er zijn speciale endpoints om bestanden op te halen uit de database, rapporten te genereren en de Profit versie op te vragen.

REST endpoints

SOAP endpoints

Kennis en ondersteuning

  • AFAS Partner oplossingen

    Bestaande en gecontroleerde oplossingen die plug and play zijn. AFAS Partners hebben kun koppeling gecertificeerd en zijn verplicht goede security tests te doen op de applicatie en op de koppeling. Lees meer op AFASPartner.nl.

  • API Cursus

    Leer de basis van de AFAS API kennen. Alle onderdelen van de API worden behandeld door een AFAS Systemintegrator. Schrijf je in voor de cursus.

  • Servicemanagement

    Wil je ondersteuning bij het ontwikkelen van een koppeling? Stuur een servicemanagement-aanvraag in.

Process

AFAS Connect Connector

Work area

Connectoren