Ga naar hoofdinhoud

ActionSetup & QuickSigningSetup (Pre-fill APIs)

Wanneer uw organisatie werkt met een extern CRM-, ERP- of makelaarspakket (zoals BrokerCloud of maatwerkbeheersoftware), wilt u voorkomen dat medewerkers handmatig klanten moeten overtypen of opzoeken in Sidefish.

Sidefish biedt hiervoor twee Pre-fill & Deep-linking APIs:

  1. QuickSigningSetup: Start direct een snelle documentondertekening vanuit uw CRM met één klik.
  2. ActionSetup: Start een vragenlijstactie waarbij de geselecteerde contacten uit het externe pakket direct klaargezet zijn in de wizard.

1. QuickSigningSetup (1-Klik Documentondertekening)​

Met de QuickSigningSetup API kan uw CRM een PDF-document en contactgegevens naar Sidefish sturen, waarna de adviseur met één klik direct in de juiste ondertekenstap van Sidefish belandt.

De Flow​

API Endpoint: Aanmaken van de Setup​

POST /api/v1/quicksigningsetup HTTP/1.1
Host: sidefish.app
x-api-key: JOUW_API_SLEUTEL
Content-Type: application/json

{
  "customer": {
    "firstname": "Pieter",
    "lastname": "Claes",
    "email": "pieter.claes@example.be",
    "gsm": "+32470123456",
    "guid": "CRM-CUST-8841"
  },
  "document": {
    "fileid": "doc_file_98765",
    "title": "Kwijting Schadedossier #2026-99",
    "type": "pdf"
  }
}

Verplichte Velden​

  • customer.firstname: Voornaam van het contact.
  • customer.lastname: Achternaam van het contact.
  • customer.email: E-mailadres voor de ondertekenuitnodiging.
  • document.fileid: Unieke bestandsreferentie van het geüploade document.
  • document.title: Titel van het document zoals zichtbaar voor de ondertekenaar.

Response (200 OK)​

{
  "success": true,
  "setupId": "64e8b1c4e12a9c001f5a9e50"
}

Stuur de adviseur in de browser direct door naar:

https://sidefish.app/sessionrequests/quicksigningrequest/64e8b1c4e12a9c001f5a9e50

De wizard opent direct bij de ondertekenopties met het contact en de PDF reeds gekoppeld.

2. ActionSetup (Vragenlijsten Vooraf Invullen)​

Met de ActionSetup API kan een extern pakket één of meerdere klanten selecteren en de adviseur direct doorsturen naar de vragenlijst-wizard in Sidefish.

API Endpoint: Aanmaken van de ActionSetup​

De ActionSetup kan worden aangeroepen met een Bearer Token (actionsetup:write scope) of API-sleutel:

POST /api/v1/actionsetup HTTP/1.1
Host: sidefish.app
Authorization: Bearer <UW_ACCESS_TOKEN>
Content-Type: application/json

{
  "customerIds": [
    "64e8b1c4e12a9c001f5a9e11",
    "64e8b1c4e12a9c001f5a9e22"
  ]
}

U kunt ook direct nieuwe klanten meegeven om aan te maken in Sidefish:

POST /api/v1/actionsetup HTTP/1.1
Host: sidefish.app
Authorization: Bearer <UW_ACCESS_TOKEN>
Content-Type: application/json

{
  "customers": [
    {
      "firstname": "Sophie",
      "lastname": "Wouters",
      "email": "sophie.wouters@example.be",
      "thirdpartyId": "CRM-90021"
    }
  ]
}

Response (200 OK)​

{
  "success": true,
  "actionSetupId": "64e8b1c4e12a9c001f5a9e60",
  "url": "https://sidefish.app/sessionrequests/64e8b1c4e12a9c001f5a9e60",
  "count": 1
}

Stuur de adviseur door naar de geretourneerde url (of open https://sidefish.app/sessionrequests/:actionSetupId):

https://sidefish.app/sessionrequests/64e8b1c4e12a9c001f5a9e60

Sidefish laadt de actiewizard en slaat de stap Selecteer je contact(en) automatisch over omdat de klanten al geselecteerd zijn.

3. Voordelen voor Externe Integratoren​

  • Geen Dubbele Data-invoer: Klantinformatie uit het bronsysteem wordt direct gesynchroniseerd naar Sidefish.
  • Naadloze Gebruikerservaring: De adviseur werkt in zijn vertrouwde CRM en opent met één klik de juiste Sidefish-stap.
  • Herbruikbare Referenties: De thirdpartyId blijft gekoppeld aan het contact en wordt bij afronding meegestuurd in de webhook.