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
  • App Connector - authenticatie
  • GetConnector - data ophalen
  • UpdateConnector - data aanmaken, aanpassen en verwijderen
  • REST API
  • SOAP API
  • Speciale connectoren
  • Kennis en ondersteuning

AFAS API

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

Lees deze informatie dan nauwkeurig

AFAS biedt twee API-typen: REST API en SOAP API. REST communiceert in JSON en SOAP in XML. Beide typen kunnen hetzelfde. Maak gebruik van de API die jouw voorkeur heeft.

GetConnectoren zijn de endpoints om data mee op te halen uit AFAS. Een externe applicatie roept het endpoint aan en AFAS genereert de data en stuurt dit terug.

UpdateConnectoren zijn de endpoints die data in AFAS toevoegen, aanpassen of verwijderen. Een externe applicatie stuurt een bericht met de data en welke actie uitgevoerd moet worden. Hierna krijg je een response of dit gelukt is.

Authenticatie werkt doormiddel van tokens die je genereert. Dit kun je handmatig doen of via One Time Password. De token genereer je in een AppConnector. In de AppConnector geef je aan welke Update- en GetConnectoren gebruikt mogen worden door de token.

Demo-omgevingen

Demo-omgevingen zijn alleen beschikbaar voor AFAS licentiehouders. Als klant kun je deze eenvoudig aanmaken. Externe ontwikkelaars hebben twee opties:

  1. Via een AFAS-klant toegang tot een demo omgeving krijgen.
  2. Onderdeel worden van het AFAS Partnerprogramma.

AFAS Connect

De API Tools vind je op connect.afas.nl en door naar het endpoint te gaan via je browser.

Systeemeisen

Zie de aparte beschrijving.

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:

  • Algemeen artikel over de App Connector
  • Security bij Connectoren
  • API-responses bij gebruik van connectoren

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:

  • GetConnectoren
  • Aanmaken GetConnector
  • Aanroepen GetConnector REST/JSON
  • Aanroepen GetConnector SOAP/XML
  • Performance GetConnector
  • Gewijzigde gegevens ophalen met de GetConnector
  • Ophalen vrij data bestand
  • Verwijderde gegevens opvragen met een GetConnector

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.

  • Beschrijvingen en voorbeelden van de endpoints
  • UpdateConnectoren via de REST API
  • UpdateConnectoren via de SOAP API
  • Response-meldingen van UpdateConnectoren

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.

Let op:

De totale omvang van een API-call is maximaal 75 MB.

Meer informatie:

  • Het volledige stappenplan van de REST API
  • Algemene beschrijving van de REST API

SOAP API

De AFAS SOAP API maakt gebruik van uitwisseling via XML.

Let op:

De totale omvang van een API-call is maximaal 75 MB.

Meer informatie:

  • Connectoren aanroepen via SOAP

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

  • SubjectConnector
  • ReportConnector
  • ImageConnector
  • FileConnector
  • VersionConnector

SOAP endpoints

  • SubjectConnector
  • ReportConnector
  • AppConnectorVersion

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 partner.afas.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.

  • Systemintegrators

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