De API bestaat uit twee generaties die naast elkaar werken: een legacy set (de klassieke .jsp-endpoints voor bestaande Outlook-plugins) en een moderne REST-variant onder /FileCap/api/..., die gestructureerde JSON-antwoorden teruggeeft. Nieuwe integraties gebruiken bij voorkeur de moderne endpoints.

De belangrijkste functies:

• Transfer – bestanden veilig uploaden en versturen, met opties voor wachtwoorden, SMS-verificatie en vervaltermijnen
• Invite – externe gebruikers uitnodigen om bestanden naar je te sturen
• Validation & DLP – bestanden, domeinen en berichten controleren op basis van beveiligingsregels
• Settings – wachtwoordbeleid en mailplugin-configuratie opvragen
• Block & Devices – verzonden overdrachten intrekken en externe apparaten registreren met een eigen API-sleutel

Elke aanroep is beveiligd met een API-sleutel per portaal; geselecteerde endpoints ondersteunen aanvullend een apparaat-specifieke sleutel of JWT-token.

‍

Aan de slag

1. Basis-URL instellen – alle endpoints draaien onder /FileCap. Gebruik je server-URL zonder slash aan het eind, bijvoorbeeld https://filecap.example.com. Aanroepen worden dan opgebouwd als {basis-URL}/FileCap/<pad>.
2. API-sleutel toevoegen – vraag de APIKey van je FileCap-tenant op bij je beheerder en stuur deze mee in elke aanroep (behalve bij de publieke validate/*- en wachtwoordregel-endpoints).
3. Eerste aanroep doen – gebruik bij voorkeur de moderne JSON-endpoints. Een geslaagd antwoord ziet er zo uit:

json

  {
    "success": true,
    "value": { },
    "errorMessage": null
  }

Bij een fout is success gelijk aan false en staat de reden in errorMessage.

4. Apparaat registreren (optioneel) – wil je met een eigen apparaatsleutel werken, registreer dan je systeem via /api/user/devices/register, bevestig de per e-mail toegestuurde code via /api/user/devices/verify en gebruik het ontvangen token in je aanroepen.

Let op: sommige endpoints zijn gelimiteerd (rate limiting). Bij te veel verzoeken geeft de server een 429-status terug.

‍

‍