JOIN Rest API: verschil tussen versies

Uit JOIN wiki
Ga naar: navigatie, zoeken
(Waar vind ik de JOIN API?)
(Hoe werkt de JOIN API?)
Regel 11: Regel 11:
 
De JOIN RestAPI werkt zoals je kunt verwachten van een RestAPI.
 
De JOIN RestAPI werkt zoals je kunt verwachten van een RestAPI.
  
Wat moet je nog meer weten?
+
=== Wat moet je nog meer weten? ===
 +
Om als klant gebruik te kunnen maken van de RestAPI heb je een geldige licentie nodig voor iedere aansluiting die op de RestAPI wordt gerealiseerd. Voor vragen hierover kun je terecht bij de accountmanager.
  
Troubleshooting?
+
Daarnaast moet er in JOIN Mobile een zogenaamde systeemdefinitie worden aangemaakt. Hiermee zorgen we er tevens voor dat alleen toegestane systemen via de RestAPI JOIN mogen benaderen. Omdat de API onderdeel uitmaakt van JOIN Zaak & Document wordt uiteraard zorgvuldig aandacht besteed aan autorisatie & beveiliging.
  
 +
=== Troubleshooting? ===
 
Kun je bepaalde operaties niet uitvoeren of krijg je een foutmelding? Allereerst kun je in de API zelf kijken  
 
Kun je bepaalde operaties niet uitvoeren of krijg je een foutmelding? Allereerst kun je in de API zelf kijken  
  
 
Is de API niet bereikbaar of gaat er iets anders mis? Neem dan contact op met een van de supportcollega's en maak een ticket aan via <nowiki>https://joinsupport.decos.com</nowiki>
 
Is de API niet bereikbaar of gaat er iets anders mis? Neem dan contact op met een van de supportcollega's en maak een ticket aan via <nowiki>https://joinsupport.decos.com</nowiki>

Versie van 22 mei 2019 om 05:36

JOIN Zaak & Document beschikt over een RestAPI. Deze API stelt andere softwaretoepassingen in staat om op een laagdrempelige, veilige en moderne manier gebruik te maken van de functionaliteiten van JOIN Zaak & Document. Denk dan bijvoorbeeld aan het ophalen van gegevens en taken, het uitvoeren van zoekopdrachten (op basis van JOIN Search) en het aanmaken van zaken en documenten.

Op deze pagina vind je meer informatie over de RestAPI: hoe kun je deze bereiken, waar vind je de uitgebreide documentatie en op welke manier kan er gebruik worden gemaakt van de API.

Wat is een API?

Waar vind ik de JOIN API?

de API wordt standaard meegeleverd met de installatie van JOIN, of je nu in de cloud zit of niet. Achter het adres van JOIN typ je "/aspx/api". Je wordt dan automatisch doorgeleid naar de index-pagina van de API. Wij maken gebruik van Swagger, waarmee je snel en eenvoudig door alle beschikbare operaties van de API kunt navigeren.

Hoe werkt de JOIN API?

De JOIN RestAPI werkt zoals je kunt verwachten van een RestAPI.

Wat moet je nog meer weten?

Om als klant gebruik te kunnen maken van de RestAPI heb je een geldige licentie nodig voor iedere aansluiting die op de RestAPI wordt gerealiseerd. Voor vragen hierover kun je terecht bij de accountmanager.

Daarnaast moet er in JOIN Mobile een zogenaamde systeemdefinitie worden aangemaakt. Hiermee zorgen we er tevens voor dat alleen toegestane systemen via de RestAPI JOIN mogen benaderen. Omdat de API onderdeel uitmaakt van JOIN Zaak & Document wordt uiteraard zorgvuldig aandacht besteed aan autorisatie & beveiliging.

Troubleshooting?

Kun je bepaalde operaties niet uitvoeren of krijg je een foutmelding? Allereerst kun je in de API zelf kijken

Is de API niet bereikbaar of gaat er iets anders mis? Neem dan contact op met een van de supportcollega's en maak een ticket aan via https://joinsupport.decos.com