Mit Haiilo's API kannst Du die Profilfelder eines Nutzers mit Informationen aktualisieren. Im Folgenden zeigen wir Dir ein Beispiel, wie Du mithilfe von Postman in nur wenigen Schritten ein Nutzerprofil finden und aktualisieren kannst.

Um Anfragen an die Haiilo-API zu stellen, musst du dich zuerst authentifizieren. Detaillierte Informationen zur Authentifizierung und Verwendung der API findest du hier.

Schritt 1: Die Profilinformationen deiner Nutzer auflisten

1. Stelle eine GET-Anfrage an den Endpunkt /api/users, um eine Liste Deiner Nutzer mit ihren Profilinformationen zu erhalten

Du kannst unten ein Beispiel dafür sehen, wie die Antwort aussehen könnte. Unter Properties siehst Du die verfügbaren Profilfelder für einen Nutzer. Wenn ein Profilfeld leer ist, wird null angezeigt.

• {
  "tenant": "9dba828f-623b-45de-9067-xxxxxxxxx",
  "loginName": "susanne.miller@haiilo.com",
  "loginNameAlt": "sm",
  "moderatorMode": false,
  "status": "ACTIVE",
  "active": true,
  "anonymized": false,
  "firstname": "Susanne",
  "lastname": "Miller",
  "email": "susanne.miller@haiilo.com",
  "language": "EN",
  "timezone": "America/New_York",
  "properties": {
     "xing": null,
     "about": null,
     "phone": "+1 212 2345678",
     "skype": null,
     "mobile": "+1 212 2345678",
     "office": "Remote",
     "company": "Haiilo Inc.",
     "twitter": null,
     "website": "https://www.haiilo.com",
     "birthday": "1990-08-08",
     "facebook": null,
     "homeTown": "Hickory, North Carolina",
     "jobTitle": "Internal Communications Manager",
     "linkedin": null,
     "location": "New York City, New York",
     "projects": null,
     "education": null,
     "expertise": null,
     "interests": "Nature photography, swimming",
     "languages": "English, Spanish",
     "department": "Communications",
     "roomnumber": "42",
     "haiilo_pronouns": "they/them"
  },
  "manager": null,
  "updatedId": 364,
  "id": "106def2b-b36b-48c6-88dd-xxxxxxx",
  "entityId": {
     "id": "106def2b-b36b-48c6-88dd-xxxxxxx",
     "typeName": "user"
  },
  "slug": "susanne-miller",
  "typeName": "user",
  "displayName": "Susanne Miller",
  "displayNameInitials": "SM",
  "color": "#7e63a6",
  "target": {
     "name": "user",
     "displayName": null,
  "params": {
     "id": "106def2b-b36b-48c6-88dd-xxxxxxx",
     "slug": "susanne-miller"
  }
  },
  "externalWorkspaceMember": false,
  "imageUrls": {
     "cover": "/api/senders/106def2b-b36b-48c6-88dd-xxxxxxx/images/cover?modified=1694611334192",
     "avatar": "/api/senders/106def2b-b36b-48c6-88dd-xxxxxxx/images/avatar?modified=1694688826731"
  },
  "public": true
  }

Du kannst auch über die API weitere verfügbare Profilfelder für Deine Nutzer hinzufügen; erfahre mehr unter API: Anpassen von Profilfeldern.

Schritt 2: Profilfelder für einen Nutzer ausfüllen

Du kannst Informationen in die Profile eines Nutzers wie folgt eintragen:

1. Kopiere die Felder, die Du aus der Antwort ausfüllen möchtest. Beginne den reinen Text mit einem { und beende ihn mit einem }. Zum Beispiel:

   { 
    "projects": null,
    "education": null,
    "expertise": null  
   } 
   

2. Gib die kopierten Felder im Anfrage-Body ein.
3. Füge die gewünschten Informationen für jedes Profilfeld in doppelte Anführungszeichen ein.
   • In unserem Beispiel fügen wir Informationen für Projekte, Ausbildung und Expertise hinzu:

     { 
      "projects": "IC Restructuring",
      "education": "Bachelor of Communications",
      "expertise": "Everything" 
     }        

4. Führe eine POST-Anfrage an den Endpunkt /api/users/<user_id>/profile/fields aus

Du solltest eine 204 No Content Antwort erhalten. Führe eine weitere GET-Anfrage durch oder überprüfe das Profil des Nutzers auf der Plattform, um zu überprüfen, ob die Informationen hinzugefügt wurden.

Wenn Du beim Aufrufen der API Fehlermeldungen erhältst, ist eine häufige Ursache die Body-Syntax. Stelle sicher, dass alle Klammern geschlossen sind, alle Parameter in Anführungszeichen stehen und zwischen den einzelnen Feldern in der Liste Kommas stehen.