File API - Healthcheck update 22-10-2024

[#1]

Deze release notes zijn van technische aard en bedoeld voor File API ontwikkelaars die rechtstreeks met de File API integreren of de technische werking van de File API kennen.

Deel deze release notes met jouw IT afdeling.

File API Healthcheck Endpoint

Huidige Situatie

Een goede gewoonte bij het gebruik van API's is het controleren van hun status voordat ze daadwerkelijk worden aangeroepen.

Momenteel is de enige manier om erachter te komen of de File API operationeel is, het aanroepen van een van de beschikbare eindpunten (bijvoorbeeld het List-eindpunt) en het controleren van het resultaat.

Als het resultaat een fout is, moet uw uitwisselingsproces de fout afhandelen..

Een betere manier is om de status van de File API te controleren voordat u uw uitwisselingsproces start.

Om dit te vergemakkelijken en verbeteren hebben we een nieuw “Health Check”-eindpunt geïntroduceerd dat kan worden aangeroepen voordat uw uitwisselingsproces begint.

Nieuwe situatie

Vanaf heden, 22 oktober 2024, is het ‘Health Check’ eindpunt beschikbaar om de status van de File API te controleren.

Dit nieuwe eindpunt vertelt je of de File API volledig operationeel is of dat er sprake is van een storing. In geval van een storing kunt u uw uitwisselingsproces uitstellen tot een later tijdstip.

Het eindpunt kan op 3 verschillende manieren worden gebruikt:

• Handmatig (bijv met Postman) om de beschikbaarheid op een willekeurig moment te kunnen controleren.
• Automatisch (als onderdeel van uw monitoringsysteem) om regelmatig de status van de File API te controleren.
• Automatisch (als onderdeel van uw uitwisselingsproces) vlak voordat uw geautomatiseerde uitwisselingsproces begint.

In de toekomst zullen de resultaten van de health check ook in Youforce worden weergegeven, waardoor de handmatige verificatie veel sneller en intuïtief zal verlopen.

Response van het ‘Health Check’ eindpunt

Het eindpunt retourneert de algemene status van de File API en de status van elk individueel eindpunt. 

De mogelijke waarden voor de algemene status van de File API zijn:

• Operational: Wanneer de status van alle eindpunten “healthy” is.
• Major Outage: Wanneer de status van een van de meest gebruikte eindpunten ‘unhealthy’ is. De meest gebruikte eindpunten zijn: 
  • Publisher UploadMultipart
  • Subscriber Delivery
  • Subscriber List
  • Subscriber Download
• Partial Outage: Wanneer de status van de meest gebruikte eindpunten ‘healthy’ is, maar de status van een van de minder gebruikte eindpunten ’unhealthy’ is. De minder gebruikte eindpunten zijn:
  • Publisher UploadResumable
  • Publisher List
  • Publisher Download
  • Subscriber DownloadByChunks
  • Subscriber Delete

Jouw Actie 

Als u het Health Check-eindpunt wilt gaan gebruiken om de status van de File API te controleren, volgt u de stappen zoals die worden uitgelegd in onze technische File API-documentatie. 

Zie onderstaande technische links:

• File API documentation 
• File API Swagger 
• File API Postman Collection