Verbinden Sie Ihre Systeme mit Pulsika, um Personaldaten, Standorte, Urlaub, Performance, Weiterbildung und weitere Unternehmensdaten zu lesen und zu aktualisieren. Die API verwendet JSON über HTTPS, mit eigenen Schlüsseln für jedes System und Berechtigungen für jede Ressource.
Öffnen Sie als Inhaber oder Administrator des Unternehmens Zugriff → API-Schlüssel und wählen Sie „Neuer Schlüssel“.
Benennen Sie den Schlüssel nach dem System, das ihn nutzt. Geben Sie nur die nötigen Lese- oder Schreibrechte und beschränken Sie den Zugriff, wo möglich, auf die IP-Adressen des Systems.
Kopieren Sie den Schlüssel: Er wird einmal angezeigt. Pulsika speichert nur einen Fingerabdruck davon.
Rufen Sie die Adresse Ihres Unternehmens mit dem Schlüssel im Header Authorization auf.
Jeder Aufruf geht an die eigene Adresse Ihres Unternehmens:
Senden Sie den Schlüssel im Header Authorization als Bearer-Token. Ein Schlüssel funktioniert nur unter der Adresse seines eigenen Unternehmens. Er kann ablaufen, pausiert und fortgesetzt oder jederzeit widerrufen werden; er kann auf IP-Adressen oder Bereiche beschränkt werden. Änderungen werden unter dem Namen der Person erfasst, die den Schlüssel angelegt hat. Verliert sie das Recht, API-Schlüssel zu verwalten, behält der Schlüssel den Lesezugriff, kann aber keine Daten mehr schreiben.
Authorization: Bearer hq_12_••••••••
Berechtigungen
Für jede Ressource kann ein Schlüssel Lese- ({resource}:read) und Schreibrechte ({resource}:write) haben. Sie gelten für die Daten des ganzen Unternehmens. Zwei weitere Berechtigungen gibt es: sensitive, zum Lesen und Schreiben als sensibel markierter eigener Felder, und metrics:write, zum Senden von KPI-Werten über fachliche Referenzen.
Anfragen und Antworten
Anfragen und Antworten verwenden JSON mit UTF-8-Kodierung. Senden Sie Content-Type: application/json, wenn Sie einen Anfragetext senden.
Verwenden Sie YYYY-MM-DD für Datumsangaben und ISO 8601 für Zeitpunkte. Antworten verwenden UTC, zum Beispiel 2026-05-01T08:00:00Z.
Ein einzelner Eintrag wird als {"data": {…}} zurückgegeben, eine Liste als {"data": […], "meta": {page, per_page, total, last_page}, "links": {next, prev}}.
Listen: page (ab 1), per_page (standardmäßig 25, höchstens 100), sort (id, created_at, updated_at; ein Minus für absteigend), updated_since (nach einem Zeitpunkt geänderte Einträge, zur Synchronisierung), dazu die Filter jeder Ressource.
Legen Sie Einträge mit POST an und aktualisieren Sie sie mit PATCH, wobei Sie nur die geänderten Felder senden. DELETE liefert 204. Anfragen mit nicht schreibbaren Feldern werden abgelehnt.
Schreibvorgänge sind atomar: Alle Änderungen werden gemeinsam gespeichert oder keine.
GET https://compania-mea.pulsika.eu/api/v1/employees?status=active&updated_since=2026-05-01T00:00:00Z&page=2
Fehler
Fehler werden als {"error": "<code>", "message": "<text>"} zurückgegeben. Ungültige Daten liefern Status 422 mit Details unter "errors" für jedes betroffene Feld.
Status
Code
Bedeutung
401
invalid_token
Der Schlüssel fehlt, ist unbekannt oder gehört zu einem anderen Unternehmen.
403
token_inactive
Der Schlüssel ist pausiert oder abgelaufen.
403
not_in_plan
Der Tarif des Unternehmens enthält diese Art von Schlüssel nicht (Automatisierungsschlüssel: ab Professional; die vollständige API: Enterprise).
403
insufficient_scope
Dem Schlüssel fehlt die für diesen Vorgang nötige Berechtigung.
403
ip_not_allowed
Der Schlüssel nimmt keine Aufrufe von dieser Adresse an.
403
token_owner_inactive
Die Person, die den Schlüssel angelegt hat, darf keine Schlüssel mehr verwalten: Er kann weiter lesen, aber nicht mehr schreiben.
404
—
Keine solche Ressource oder kein solcher Eintrag in Ihrem Unternehmen (oder nicht in Ihrem Tarif).
405
—
Die Ressource bietet diesen Vorgang nicht an.
409
in_use
Der Eintrag wird noch anderswo verwendet und kann nicht gelöscht werden.
422
—
Ungültige Daten; es wurde nichts gespeichert.
429
—
Zu viele Anfragen; versuchen Sie es nach Retry-After Sekunden erneut.
Limits
Das Limit beträgt 120 Anfragen pro Minute und Schlüssel und 300 pro IP-Adresse. Bei Überschreitung antwortet die API mit Status 429. Der Header Retry-After gibt an, wie lange bis zum nächsten Versuch zu warten ist.
Versionen
Die aktuelle Version ist 1 (/api/v1). Neue Ressourcen, Felder und Filter werden in dieser Version ergänzt. Inkompatible Änderungen kommen in einer neuen Version, die vorab angekündigt wird.
Personenbezogene Daten
Persönliche Kennnummern (Steuer-ID, Sozialversicherungsnummer, die rumänische CNP) können über die API weder gelesen noch geschrieben werden.
Der Zugriff auf sensible eigene Felder erfordert die Berechtigung sensitive.
Ergebnisse anonymer Umfragen gibt es nur als Summen. Sie sind nicht verfügbar, solange die Antworten versiegelt sind oder es zu wenige gibt, um die Anonymität der Teilnehmenden zu schützen.
Das API-Protokoll speichert Schlüssel, Endpunkt, Antwortstatus und Dauer 30 Tage lang, ohne Inhalt von Anfrage oder Antwort. Die letzten Aufrufe finden Sie unter Zugriff → API-Schlüssel.
KPI-Werte senden
Systeme, die nur KPI-Werte senden (Umsätze, Bewertungen, Zählungen), können das über fachliche Referenzen statt IDs tun: POST /api/v1/metrics/{key}/values mit einem Zeitraum und den Werten für Mitarbeiter (über die Personalnummer), Standorte oder Abteilungen (über das Kürzel). Erfordert die Berechtigung metrics:write; GET /api/v1/metrics listet die Kennzahlen, die Werte annehmen.
Der Baum aus Ländern, Regionen und Zonen, zu denen die Standorte gehören; er bestimmt auch den Zuständigkeitsbereich der Gebietsleitungen. Namen sind unter Geschwistern eindeutig. Das Löschen wird abgelehnt, solange Standorte oder Untergebiete es verwenden.
Berechtigungen: geo_areas:read, geo_areas:write
Endpunkte
GET/api/v1/geo-areasListe
GET/api/v1/geo-areas/{id}Ein Eintrag
POST/api/v1/geo-areasAnlegen
PATCH/api/v1/geo-areas/{id}Ändern
DELETE/api/v1/geo-areas/{id}Löschen
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
name
stringerforderlich
Name, eindeutig unter den Gebieten mit demselben übergeordneten Gebiet.
level_label
string | null
Wie diese Ebene heißt (Land, Region, Zone).
parent_id
integer | null
Das Gebiet, in dem es liegt; null für ein oberstes Gebiet. Nie es selbst oder eines seiner Untergebiete.
Die Standorte des Unternehmens: Filialen, Apotheken, Büros, Hotels. Das Löschen wird abgelehnt, solange noch Personen, Dokumente oder Ergebnisse darauf verweisen.
Berechtigungen: work_units:read, work_units:write
Endpunkte
GET/api/v1/work-unitsListe
GET/api/v1/work-units/{id}Ein Eintrag
POST/api/v1/work-unitsAnlegen
PATCH/api/v1/work-units/{id}Ändern
DELETE/api/v1/work-units/{id}Löschen
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
name
stringerforderlich
Name, eindeutig im Unternehmen.
code
string | null
Ihr eigenes Kürzel, eindeutig im Unternehmen (zur Zuordnung von KPI-Werten).
geo_area_id
integer | null
Das Gebiet (Region, Land), zu dem er gehört.
address
string | null
Straße und Hausnummer.
city
string | nullnur lesbar
Ort (aus der amtlichen Liste bei rumänischen Standorten).
county
string | nullnur lesbar
Kreis oder Region.
phone
string | null
Telefon.
email
string | null
E-Mail.
opened_on
date | null
Eröffnungsdatum.
closed_on
date | null
Schließungsdatum.
is_active
boolean
Ob er in Verwendung ist.
custom_fields
object
Die eigenen Felder des Unternehmens, nach Feld-ID (siehe /custom-fields).
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
code
string
Genaues Kürzel (ohne Beachtung der Groß-/Kleinschreibung).
Unternehmensweite Bereiche (Vertrieb, Logistik …), die verschachtelt werden können. Das Löschen wird abgelehnt, solange Zuordnungen oder Unterabteilungen sie verwenden.
Gruppen von Personen über Standorte hinweg (ein Projekt, eine Arbeitsgruppe). Mitglieder werden einzeln mit den Aktionen unten hinzugefügt und entfernt.
Berechtigungen: teams:read, teams:write
Endpunkte
GET/api/v1/teamsListe
GET/api/v1/teams/{id}Ein Eintrag
POST/api/v1/teamsAnlegen
PATCH/api/v1/teams/{id}Ändern
DELETE/api/v1/teams/{id}Löschen
POST/api/v1/teams/{id}/add-memberFügt einen Mitarbeiter zum Team hinzu (nichts ändert sich, wenn sie schon dabei ist). Inhalt: {"employee_id": 345}.
POST/api/v1/teams/{id}/remove-memberEntfernt einen Mitarbeiter aus dem Team. Inhalt: {"employee_id": 345}.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
name
stringerforderlich
Name, eindeutig im Unternehmen.
description
text | null
Beschreibung.
is_active
boolean
Ob es in Verwendung ist.
member_ids
arraynur lesbar
Die Mitarbeiter im Team (nur lesbar; ändern Sie sie mit add-member / remove-member).
custom_fields
object
Die eigenen Felder des Unternehmens, nach Feld-ID (siehe /custom-fields).
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
is_active
boolean
true oder false.
employee_id
integer
Nur die Teams, in denen diese Person ist.
/api/v1/teams/{id}/add-member: employee_id (integer) — Die hinzuzufügende Person (eine ID aus /employees).
/api/v1/teams/{id}/remove-member: employee_id (integer) — Die zu entfernende Person (eine ID aus /employees).
Die Felder, die das Unternehmen seinen eigenen Einträgen hinzugefügt hat, nur lesbar: was jede ID in den custom_fields eines Eintrags bedeutet, ihr Typ und ihre Auswahlen. Sensible Felder zu Mitarbeitern werden nur für einen Schlüssel mit der Berechtigung sensitive aufgeführt. Die Felder werden in der Anwendung festgelegt.
Berechtigungen: custom_fields:read
Endpunkte
GET/api/v1/custom-fieldsListe
GET/api/v1/custom-fields/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung; der Schlüssel in den custom_fields eines Eintrags.
entity
employee | work_unit | department | position | team | companynur lesbar
Die Art von Eintrag, zu der es gehört.
label
stringnur lesbar
Sein Name, in der Sprache der Anfrage (Accept-Language).
type
text | textarea | number | date | boolean | select | multiselect | urlnur lesbar
Was es enthält: text, textarea, number, date (Y-m-d), boolean, select, multiselect oder url.
options
array | nullnur lesbar
Die Auswahlen eines select oder multiselect: id und label; gespeichert wird die id.
is_required
booleannur lesbar
Ob ein Wert erforderlich ist.
visibility
reach | sensitivenur lesbar
reach (alle, die die Person sehen) oder sensitive.
is_active
booleannur lesbar
Ob es in Verwendung ist.
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
entity
employee | work_unit | department | position | team | company
Die Personen des Unternehmens. Beim Anlegen entsteht auch ihre erste Zuordnung; spätere Wechsel laufen über /placements. Persönliche Kennnummern (Steuer-ID, Sozialversicherungsnummer, die rumänische CNP) werden über die API nie gelesen oder geschrieben. Konten werden in der Anwendung angelegt.
Berechtigungen: employees:read, employees:write
Endpunkte
GET/api/v1/employeesListe
GET/api/v1/employees/{id}Ein Eintrag
POST/api/v1/employeesAnlegen
PATCH/api/v1/employees/{id}Ändern
DELETE/api/v1/employees/{id}Löschen
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
employee_number
string | null
Ihre Personalnummer, eindeutig im Unternehmen (zur Zuordnung von KPI-Werten).
first_name
stringerforderlich
Vorname.
last_name
stringerforderlich
Nachname.
email
string | null
Dienstliche E-Mail.
phone
string | null
Telefon.
birth_date
date | null
Geburtsdatum.
hire_date
date | null
Eintrittsdatum (die erste Zuordnung beginnt an diesem Tag).
termination_date
date | null
Austrittsdatum.
status
active | inactive | terminated
active, inactive oder terminated.
work_unit_id
integererforderlich
Standort der aktuellen Hauptzuordnung; beim Anlegen erforderlich, danach nur lesbar.
department_id
integer | null
Abteilung der aktuellen Hauptzuordnung (nur beim Anlegen).
position_id
integer | null
Position der aktuellen Hauptzuordnung (nur beim Anlegen).
has_login
booleannur lesbar
Ob sich die Person anmelden kann.
custom_fields
object
Die eigenen Felder des Unternehmens, nach Feld-ID; sensible nur mit der Berechtigung sensitive.
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
status
active | inactive | terminated
Nur mit diesem Status.
work_unit_id
integer
Derzeit diesem Standort zugeordnet.
employee_number
string
Genaue Personalnummer.
email
string
Genaue E-Mail.
q
string
Teil des Namens.
hired_since
date
Eingestellt ab diesem Datum (Y-m-d): neue Mitarbeitende.
leaving_since
date
Austritt ab diesem Datum (Y-m-d): ein Austrittsdatum ist gesetzt.
Wo jede Person arbeitet: Standort, Abteilung und Position, von wann bis wann. Eine neue Hauptzuordnung löst die vorherige ab, die als aktuelle Nebenzuordnung bleibt, bis sie beendet wird.
Berechtigungen: placements:read, placements:write
Endpunkte
GET/api/v1/placementsListe
GET/api/v1/placements/{id}Ein Eintrag
POST/api/v1/placementsAnlegen
DELETE/api/v1/placements/{id}Löschen
POST/api/v1/placements/{id}/endBeendet die Zuordnung am valid_to (nicht vor ihrem Beginn).
POST/api/v1/placements/{id}/make-primaryMacht sie zur Hauptzuordnung der Person; die bisherige Hauptzuordnung wird zur Nebenzuordnung.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
employee_id
integererforderlich
Die Person.
work_unit_id
integererforderlich
Der Standort.
department_id
integer | null
Die Abteilung.
position_id
integer | null
Die Position.
is_primary
boolean
Ob es die Hauptzuordnung der Person ist.
valid_from
dateerforderlich
Erster Tag.
valid_to
date | null
Letzter Tag (leer: noch aktuell).
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
employee_id
integer
Nur die dieser Person.
work_unit_id
integer
Nur an diesem Standort.
current
boolean
true: nur heute gültige Zuordnungen.
/api/v1/placements/{id}/end: valid_to (date) — Der letzte Tag der Zuordnung (Y-m-d).
Abwesenheitsanträge, nach denselben Regeln wie in der Anwendung: Die Arbeitstage werden gezählt, Urlaubskonto und Überschneidungen geprüft, und der Genehmigungsablauf des Unternehmens beginnt. Genehmigen und Ablehnen folgen dem Ablauf des Antrags: Die Person, die den Schlüssel angelegt hat, muss im aktuellen Schritt genehmigen dürfen.
POST/api/v1/leave-requests/{id}/approveGenehmigt den aktuellen Schritt (Kommentar optional).
POST/api/v1/leave-requests/{id}/rejectLehnt den Antrag ab; Kommentar (der Grund) erforderlich.
POST/api/v1/leave-requests/{id}/cancelStorniert einen offenen oder genehmigten Antrag.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
employee_id
integererforderlich
Die abwesende Person.
leave_type_id
integererforderlich
Die Abwesenheitsart.
starts_on
dateerforderlich
Erster Tag.
ends_on
dateerforderlich
Letzter Tag.
half_start
boolean
Der erste Tag ist nur nachmittags (zählt als halber Tag).
half_end
boolean
Der letzte Tag ist nur vormittags (zählt als halber Tag).
days
numbernur lesbar
Gezählte Tage (Arbeitstage ohne Feiertage; halbe Tage zählen 0,5).
hours
number | null
Bei einer in Stunden gezählten Art: die Stunden, die sie umfasst (die Stunden ihrer Tage laut Arbeitszeitmodell der Person). Beim Anlegen: ein Teil eines eintägigen Antrags.
for_child
boolean
Für ein erkranktes Kind beantragt (eine Art, die dafür eine weitere Woche erlaubt).
Das Jahreskonto jeder Person pro Abwesenheitsart mit Tageszählung. Beim Auflisten eines Jahres wird es für jede aktive Person eröffnet, anteilig und mit Übertrag, wie in der Anwendung; genommen, beantragt und verfügbar werden berechnet. Anspruch, Korrektur und Übertrag können geändert werden – nie beim eigenen Datensatz der Person, die den Schlüssel angelegt hat.
Der Kalender des Unternehmens. Teilnehmende (oder der Standort) werden über einen neuen Termin, eine neue Uhrzeit oder einen neuen Ort benachrichtigt. Ein neuer Termin kann sich wiederholen: Jede Wiederholung wird ein eigener Termin in einer Serie und wird einzeln geändert, abgesagt oder gelöscht.
Was das Unternehmen misst: Schlüssel und Einheit jeder Kennzahl, für welche Subjekte sie gemessen wird (grain) und wie oft (period). Nur lesbar; Kennzahlen werden in der Anwendung festgelegt. Werte können über die API nur an Kennzahlen mit der Quelle „api“ gesendet werden.
Berechtigungen: kpi_metrics:read
Endpunkte
GET/api/v1/kpi-metricsListe
GET/api/v1/kpi-metrics/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
key
stringnur lesbar
Der Schlüssel der Kennzahl, verwendet in Formeln und beim Senden von Werten.
Der Wert einer Kennzahl für ein Subjekt in einem Zeitraum. Beim Anlegen wird er geschrieben (oder ersetzt den bereits vorhandenen Wert für dieses Subjekt und diesen Zeitraum); nur Kennzahlen mit der Quelle „api“ nehmen Werte an. Ein fehlender Wert (null) bedeutet „keine Daten“, nie null. Um viele Werte über fachliche Referenzen (Personalnummer, Standortkürzel) zu senden, verwenden Sie POST /metrics/{key}/values.
KPI-Scorecards und alle ihre Versionen (Entwurf, veröffentlicht, archiviert): die Teile, aus denen ein Score besteht, ihre Gewichtungen und die Stufen, in die ein Score fällt. Nur lesbar; KPI-Scorecards werden in der Anwendung gebaut, und eine veröffentlichte Version ändert sich nie.
Berechtigungen: kpi_scorecards:read
Endpunkte
GET/api/v1/kpi-scorecardsListe
GET/api/v1/kpi-scorecards/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung dieser Version.
family
stringnur lesbar
Die KPI-Scorecard über ihre Versionen hinweg.
version
integernur lesbar
Versionsnummer.
name
stringnur lesbar
Name.
description
string | nullnur lesbar
Beschreibung.
grain
employee | team | department | work_unit | geo_area | companynur lesbar
Wen sie bewertet.
period
day | week | month | quarter | yearnur lesbar
Wie oft sie bewertet.
status
draft | published | archivednur lesbar
draft, published oder archived.
effective_from
date | nullnur lesbar
Gültig ab.
effective_to
date | nullnur lesbar
Gültig bis.
published_at
datetime | nullnur lesbar
Wann diese Version veröffentlicht wurde.
components
arraynur lesbar
Ihre Teile: key, label, Gewichtung (0–1), Zielwert, Anzeigeformat, ob die Person ihn sieht.
levels
arraynur lesbar
Ihre Stufen: Name, der niedrigste Score, der sie erreicht, Farbe.
Scores auf den KPI-Scorecards: das aktuelle Ergebnis jedes Subjekts und Zeitraums, die erreichte Stufe sowie Wert und Punkte jedes Teils. Eine Gesamtwertung oder ein Teil ohne Daten ist null, nie 0. Nur lesbar; Ergebnisse entstehen beim Abschluss eines Zeitraums.
Berechtigungen: kpi_results:read
Endpunkte
GET/api/v1/kpi-resultsListe
GET/api/v1/kpi-results/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
scorecard_id
integernur lesbar
Die Version der KPI-Scorecard, die bewertet hat.
scorecard
stringnur lesbar
Ihr Name.
subject_type
employee | team | department | work_unit | geo_area | companynur lesbar
Die Art des Subjekts.
subject_id
integernur lesbar
Die ID des Subjekts.
subject
string | nullnur lesbar
Der Name des Subjekts.
period
datenur lesbar
Erster Tag des Zeitraums.
total
string | nullnur lesbar
Der Score als Dezimalzeichenkette; null, wenn es keine Daten gibt.
level
string | nullnur lesbar
Die erreichte Stufe.
level_color
string | nullnur lesbar
Die Farbe der Stufe.
bonus
string | nullnur lesbar
Der Bonus, falls die KPI-Scorecard einen berechnet.
parts
arraynur lesbar
Jeder Teil: key, label, Wert und die Punkte, die er bringt (Dezimalzeichenketten; null für keine Daten).
created_at
datetimenur lesbar
Wann er berechnet wurde.
Filter
scorecard_id
integer
Nur diese Version der KPI-Scorecard.
period
date
Erster Tag des Zeitraums (Y-m-d).
subject_type
employee | team | department | work_unit | geo_area | company
Wohin das Unternehmen, ein Gebiet, ein Standort, eine Abteilung oder eine Person in einem Zeitraum steuert, und die Schlüsselergebnisse, an denen es gemessen wird, mit dem Stand jedes einzelnen (Fortschritt in Prozent und wo es heute stehen sollte). Nur lesen, dazu die Aktion move für von Hand verfolgte Schlüsselergebnisse; ein Schlüsselergebnis, das eine KPI-Kennzahl liest, bewegt sich mit ihren Daten. Entwürfe erscheinen nie.
Berechtigungen: priorities:read, priorities:write
Endpunkte
GET/api/v1/prioritiesListe
GET/api/v1/priorities/{id}Ein Eintrag
POST/api/v1/priorities/{id}/moveEin von Hand verfolgtes Schlüsselergebnis bewegen: ein neuer Wert für eine Zahl, erreicht oder nicht für einen Schritt, mit optionaler Notiz.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
parent_id
integer | nullnur lesbar
Die Priorität, an der sie sich ausrichtet.
level
company | geo_area | work_unit | department | personnur lesbar
company, geo_area, work_unit, department oder person.
subject_id
integernur lesbar
Für wen: das Gebiet, der Standort, die Abteilung oder die Person (0 für das Unternehmen).
owner_id
integer | nullnur lesbar
Das verantwortliche Konto.
title
stringnur lesbar
Was erreicht werden soll.
description
text | nullnur lesbar
Warum es wichtig ist.
period_type
month | quarter | yearnur lesbar
month, quarter oder year.
period_start
datenur lesbar
Erster Tag des Zeitraums.
period_end
datenur lesbar
Letzter Tag.
status
active | closed | cancellednur lesbar
active, closed oder cancelled.
progress
number | nullnur lesbar
Der Stand in Prozent (null = noch keine Daten).
expected
numbernur lesbar
Wo es heute stehen sollte, in Prozent.
key_results
arraynur lesbar
Jedes Schlüsselergebnis: Art (manual, milestone, metric), Titel, Einheit, Start- und Zielwert, aktueller Wert, Fortschritt und die gelesene KPI-Kennzahl.
created_at
datetimenur lesbar
Erstellt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
level
company | geo_area | work_unit | department | person
Nur diese Ebene.
status
active | closed | cancelled
Nur dieser Status.
on
date
Nur Prioritäten, die an diesem Tag laufen (Y-m-d).
/api/v1/priorities/{id}/move: key_result_id (integer) — Das Schlüsselergebnis dieser Priorität.; value (number) — Der neue Wert (ein Zahlen-Schlüsselergebnis).; done (boolean) — Erreicht oder nicht (ein Schritt).; note (string) — Warum es sich bewegt hat.
Ziele unter einer Regel (zum Beispiel „Fokusprodukte“): Zeitraum, Parameter und Zielwerte pro Standort. Regel und Zeitraum sind nach dem Anlegen fest. Die Aktion record speichert, was Personen oder Standorte erreicht haben; bewertet wird beim Bewerten des Zeitraums. Ein bereits bewertetes Ziel kann nicht gelöscht werden.
Berechtigungen: objectives:read, objectives:write
Endpunkte
GET/api/v1/objectivesListe
GET/api/v1/objectives/{id}Ein Eintrag
POST/api/v1/objectivesAnlegen
PATCH/api/v1/objectives/{id}Ändern
DELETE/api/v1/objectives/{id}Löschen
POST/api/v1/objectives/{id}/recordErfasst, was Subjekte erreicht haben: Ihre Messwerte ersetzen das bisher Erfasste; leere Messwerte verwerfen es (wieder keine Daten).
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
rule_id
integererforderlich
Die Regel, die es bewertet (nur beim Anlegen).
rule
stringnur lesbar
Der Name der Regel.
name
stringerforderlich
Name.
description
text | null
Beschreibung.
period
stringerforderlich
Der Schlüssel des Zeitraums im Zeitraum der Regel (nur beim Anlegen), zum Beispiel 2026-09.
period_start
datenur lesbar
Erster Tag.
period_end
datenur lesbar
Letzter Tag.
params
object
Werte für die Parameter der Regel, nach Name (andere werden ignoriert); weggelassen: die Standardwerte der Regel.
targets
array
Zielwerte pro Standort: eine Liste von {work_unit_id, target}. Gibt es Zielwerte, gilt das Ziel nur für diese Standorte.
external_ref
string | null
Ihre eigene Referenz (nur beim Anlegen).
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
rule_id
integer
Nur unter dieser Regel.
period_start
date
Erster Tag des Zeitraums (Y-m-d).
external_ref
string
Ihre genaue Referenz.
/api/v1/objectives/{id}/record: achievements (array) — Eine Liste von {subject_id, measures: {Name des Messwerts: Zahl}}; Subjekte auf der Ebene der Regel, in den Standorten mit Zielwert.
Auf Beurteilungsbögen abgegebene Beurteilungen: wer, von wem, für welchen Zeitraum, Punkte und Ergebnis sowie die Antwort zu jedem Kriterium. Nur lesbar; Beurteilungen werden in der Anwendung abgegeben. Entwürfe sind laufende Arbeit der beurteilenden Person und werden nie aufgelistet.
Berechtigungen: reviews:read
Endpunkte
GET/api/v1/reviewsListe
GET/api/v1/reviews/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
form_id
integernur lesbar
Die Version des Bogens.
form
stringnur lesbar
Der Name des Bogens.
employee_id
integernur lesbar
Die beurteilte Person.
evaluator_id
integer | nullnur lesbar
Das Konto der beurteilenden Person.
period_start
datenur lesbar
Erster Tag des Zeitraums.
period_end
datenur lesbar
Letzter Tag.
status
submitted | cancellednur lesbar
submitted oder cancelled.
total_points
string | nullnur lesbar
Erreichte Punkte.
max_points
string | nullnur lesbar
Mögliche Punkte.
result
string | nullnur lesbar
Das Ergebnis (Punkte oder ein Prozentsatz, wenn der Bogen einen liefert).
comment
text | nullnur lesbar
Der Kommentar der beurteilenden Person, als reiner Text.
submitted_at
datetime | nullnur lesbar
Wann sie abgegeben wurde.
cancelled_at
datetime | nullnur lesbar
Wann sie storniert wurde.
answers
arraynur lesbar
Jedes Kriterium: key, die gewählten Optionen, ein Wert, seine Punkte und ein Kommentar.
Die gestarteten Wettbewerbe des Unternehmens (Entwürfe erscheinen nicht): was gemessen wird, wer antritt, über welche Zeiträume und wie man gewinnt. Nur lesend — Wettbewerbe werden in der App angelegt und geführt.
Bestätigte Ergebnisse, eines je Teilnahme — nach der Bestätigung unveränderlich. NULL heißt keine Daten, nie null. Das Ergebnis einer Person wird als über die API gelesen protokolliert.
Berechtigungen: contest_results:read
Endpunkte
GET/api/v1/contest-resultsListe
GET/api/v1/contest-results/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
contest_id
integernur lesbar
Der Wettbewerb.
subject_type
employee | team | work_unit | department | geo_areanur lesbar
employee, team, work_unit, department oder geo_area.
subject_id
integer | nullnur lesbar
Die Teilnahme (leer nach der Anonymisierung).
value
number | nullnur lesbar
Der Wert des Kriteriums im Wettbewerb.
baseline
number | nullnur lesbar
Der Durchschnitt der Zeiträume davor (Fortschrittswettbewerbe).
measure
number | nullnur lesbar
Was verglichen wurde: der Wert oder der Fortschritt.
place
integer | nullnur lesbar
Der Platz (Gleichstände teilen ihn).
tier_key
string | nullnur lesbar
Die erreichte Stufe (Wettbewerbe mit Stufen).
wins
booleannur lesbar
Ob gewonnen wurde.
eligible
booleannur lesbar
Ob teilnahmeberechtigt.
ineligible_reason
string | nullnur lesbar
Warum nicht: excluded, inactive, not_placed, not_present, not_employed_long_enough, no_data oder no_baseline.
Gewonnene Preise, einer je Empfänger. Der Betrag eines Bonus nur mit dem Scope sensitive; nichts zu Steuern. Die Aktion deliver markiert einen Preis als übergeben, im Namen der Person, die den Schlüssel angelegt hat (sie muss in der App Preise übergeben dürfen).
Was Wettbewerbe vergeben können: Produkte, Gutscheine, Boni, freie Tage, Erlebnisse oder nur Anerkennung. Jede Art behält nur, was sie braucht (der Wert eines Bonus ist sein Betrag; Anerkennung hat weder Wert noch Bestand). Geschrieben im Namen der Person, die den Schlüssel angelegt hat; sie muss in der App Preise verwalten dürfen.
Der Kurskatalog. Titel und Beschreibung werden in der Sprache des Unternehmens geschrieben (andere Sprachen werden in der Anwendung übersetzt); Kapitel und Titelbilder werden in der Anwendung angelegt. Ein Kurs kann nur gelöscht werden, solange er nie jemandem zugewiesen wurde – sonst archivieren Sie ihn.
Berechtigungen: courses:read, courses:write
Endpunkte
GET/api/v1/coursesListe
GET/api/v1/courses/{id}Ein Eintrag
POST/api/v1/coursesAnlegen
PATCH/api/v1/courses/{id}Ändern
DELETE/api/v1/courses/{id}Löschen
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
title
stringerforderlich
Titel.
description
text | null
Kurzbeschreibung, reiner Text.
category_id
integer | null
Kategorie.
category
string | nullnur lesbar
Name der Kategorie.
author
string | null
Verfasst von.
status
draft | published | archivederforderlich
draft, published oder archived; nur veröffentlichte Kurse können zugewiesen werden.
estimated_minutes
integer | null
Geschätzte Dauer in Minuten.
validity_months
integer | null
Wie viele Monate das Zertifikat gültig bleibt; leer: läuft nicht ab.
issues_certificate
boolean
Ob der Abschluss ein Zertifikat ausstellt.
recertifies
boolean
Ob Personen vor Ablauf des Zertifikats erneut eingeschrieben werden.
points
integererforderlich
Beim Abschluss erhaltene Punkte.
chapters_count
integernur lesbar
Anzahl der Kapitel.
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
status
draft | published | archived
Nur mit diesem Status.
category_id
integer
Nur in dieser Kategorie.
q
string
Teil des Titels.
Beispielanfrage
POST https://compania-mea.pulsika.eu/api/v1/courses
{
"title": "Siguranța la incendiu",
"status": "published",
"estimated_minutes": 20,
"validity_months": 12,
"issues_certificate": true,
"recertifies": false,
"points": 10
}
Zuweisungen von Weiterbildung /learning-assignments
Ein veröffentlichter Kurs (oder ein eigenständiger Test), der Personen gegeben wird: allen, einem Standort, einem Gebiet, einer Abteilung, einer Position oder namentlich genannten Mitarbeitern. Die Personen werden sofort eingeschrieben. Löschen nur, solange niemand begonnen hat.
Wer in welchem Kurs oder Test eingeschrieben ist und wie weit die Person gekommen ist. Aktionen: eine spätere Fälligkeit, ein weiterer Versuch, die Befreiung einer Person, die noch nicht begonnen hat.
Nach Audits festgelegte Korrekturmaßnahmen. Sie werden wie auf der Audit-Seite weitergeführt: mit einer Notiz als erledigt markiert, bestätigt, mit einem Grund wieder geöffnet oder storniert.
Genehmigungen, Verträge und Regelungen mit ihrem Ablaufdatum. Die API liest die Angaben eines Dokuments sowie Name, Größe und Typ der aktuellen Datei; die Datei selbst wird in der Anwendung heruntergeladen. Eine Datei wird als {"name", "content_base64"} gesendet (dieselben Typen wie in der Anwendung – PDF, Office, Bilder, ZIP – höchstens 50 MB); eine an ein bestehendes Dokument gesendete Datei fügt eine neue Version hinzu. Löschen verschiebt das Dokument in den Papierkorb, aus dem es in der Anwendung wiederhergestellt werden kann.
Berechtigungen: documents:read, documents:write
Endpunkte
GET/api/v1/documentsListe
GET/api/v1/documents/{id}Ein Eintrag
POST/api/v1/documentsAnlegen
PATCH/api/v1/documents/{id}Ändern
DELETE/api/v1/documents/{id}Löschen
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
title
stringerforderlich
Titel.
description
text | null
Beschreibung.
category_id
integer | null
Kategorie (siehe /document-categories).
work_unit_id
integer | null
Der Standort, zu dem es gehört; leer für ein Unternehmensdokument. Nur beim Anlegen festgelegt.
is_internal
boolean
Nur sichtbar für die Verwaltung der Dokumente.
expires_on
date | null
Ablaufdatum.
expiry_state
valid | expiring | expired | nullnur lesbar
valid, expiring oder expired (leer ohne Ablaufdatum).
repeat_months
integer | null
Alle so viele Monate erneuert.
alert_days
array | null
Tage vor Ablauf, an denen Erinnerungen versendet werden (höchstens 6).
versions
integernur lesbar
Wie viele Versionen der Datei es gibt.
file_name
string | nullnur lesbar
Der Name der aktuellen Datei.
file_size
integer | nullnur lesbar
Ihre Größe in Byte.
file_mime
string | nullnur lesbar
Ihr Typ.
file
fileerforderlich
Die Datei: {"name": "…", "content_base64": "…"}. Beim Anlegen erforderlich; beim Ändern fügt sie eine Version hinzu.
version_note
string | null
Ein Hinweis zur Version der Datei (angezeigt: der der aktuellen Version).
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
work_unit_id
integer
Nur die Dokumente dieses Standorts.
category_id
integer
Nur diese Kategorie.
company
boolean
true: nur Unternehmensdokumente; false: nur Standortdokumente.
Anfragen, an einem Standort etwas zu reparieren oder bereitzustellen, mit ihrem Verlauf. Gestellt für die in requested_by angegebene Person (die für diesen Standort Anfragen stellen können muss) oder für die Person, die den Schlüssel angelegt hat; der Genehmigungsablauf der Kategorie gilt. Weitergeführt mit der Aktion move, wie es diese Person auf dem Bildschirm darf.
POST/api/v1/service-requests/{id}/moveDie Anfrage in einen anderen Status bringen (in_progress, resolved, unresolved, open, cancelled), wie es die Person darf, die den Schlüssel angelegt hat. unresolved und Wiederöffnen brauchen einen Kommentar.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
category_id
integererforderlich
Kategorie (siehe /service-categories).
work_unit_id
integererforderlich
Der Standort, für den sie ist.
title
stringerforderlich
Kurzer Titel.
description
texterforderlich
Was nicht stimmt oder gebraucht wird.
requested_by
integer
Das Konto, für das sie gestellt wird (eine Person des Unternehmens); weggelassen: die Person, die den Schlüssel angelegt hat.
/api/v1/service-requests/{id}/move: status (awaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelled) — Der neue Status.; comment (text) — Warum (erforderlich bei unresolved und beim Wiederöffnen).
Beispielanfrage
POST https://compania-mea.pulsika.eu/api/v1/service-requests
{
"category_id": 2,
"work_unit_id": 12,
"title": "Frigiderul de vaccinuri nu mai răcește",
"description": "text",
"requested_by": 17
}
Anfragen für Material, mit ihren Positionen. Gestellt für die Person in requested_by (oder die Person, die den Schlüssel angelegt hat), für ein aktives Material und einen Standort, für den sie anfragen darf; dann übernommen, abgeschlossen (was den Bestand verringert) oder storniert, wie es diese Person auf dem Bildschirm darf.
Veröffentlichte und geschlossene Umfragen mit ihren Fragen und ihren Ergebnissen nur als Summen: wie viele jede Antwort gewählt haben, der Durchschnitt einer Skala und wie viele eine Freitextfrage beantwortet haben – nie, was sie geschrieben haben. Die Ergebnisse einer anonymen Umfrage bleiben verborgen, solange ihre Antworten versiegelt sind und solange sie weniger als 5 Antworten hat.
Berechtigungen: surveys:read
Endpunkte
GET/api/v1/surveysListe
GET/api/v1/surveys/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
title
stringnur lesbar
Titel.
description
text | nullnur lesbar
Beschreibung.
is_anonymous
booleannur lesbar
Ob die Antworten anonym sind.
is_mandatory
booleannur lesbar
Ob die Teilnahme verpflichtend ist.
status
published | closednur lesbar
published oder closed.
opens_at
datetime | nullnur lesbar
Wann sie beginnt.
closes_at
datetime | nullnur lesbar
Wann sie endet.
published_at
datetime | nullnur lesbar
Wann sie veröffentlicht wurde.
series_id
integer | nullnur lesbar
Die Umfrageserie, deren Ausgabe sie ist; leer bei einer einmaligen Umfrage.
edition
integer | nullnur lesbar
Ihre Nummer in der Serie.
questions
arraynur lesbar
Die Fragen: id, type (single, multiple, scale, text), text, required, options.
results
objectnur lesbar
Summen: hidden, sealed, responses, assigned, completed und pro Frage, wie viele geantwortet haben, Anzahl pro Option oder Skalenwert, der Durchschnitt.
Antworten auf namentliche Umfragen, eine Teilnahme pro Person mit ihren Antworten. Die Antworten einer anonymen Umfrage werden nie einzeln ausgegeben – nur ihre Summen, unter /surveys.
Berechtigungen: survey_responses:read
Endpunkte
GET/api/v1/survey-responsesListe
GET/api/v1/survey-responses/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
stringnur lesbar
Kennung (eine UUID).
survey_id
integernur lesbar
Die Umfrage.
employee_id
integernur lesbar
Wer geantwortet hat.
submitted_at
datetime | nullnur lesbar
Wann.
answers
arraynur lesbar
Die Antworten: Frage, gewählte Option, Wert (Skala) oder Text.
Social-Beiträge für das ganze Unternehmen (nicht in einer Gruppe), veröffentlicht. Angelegt von der Person, die den Schlüssel angelegt hat: ein Beitrag, oder eine Neuigkeit, eine Ankündigung, eine Aktion oder ein Wettbewerb, wenn sie Ankündigungen veröffentlichen darf; der Text ist reiner Text, mit einer Leerzeile zwischen Absätzen.
Berechtigungen: posts:read, posts:write
Endpunkte
GET/api/v1/postsListe
GET/api/v1/posts/{id}Ein Eintrag
POST/api/v1/postsAnlegen
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
type
post | news | announcement | promotion | contesterforderlich
post, news, announcement, promotion oder contest.
title
string | null
Titel (optional).
body
texterforderlich
Der Text (beim Lesen reiner Text).
author
string | nullnur lesbar
Wer ihn geschrieben hat.
comments_enabled
boolean
Ob kommentiert werden kann.
comments_count
integernur lesbar
Wie viele Kommentare.
published_at
datetime | null
Wann er veröffentlicht wird; ein Zeitpunkt in der Zukunft plant ihn ein.
created_at
datetimenur lesbar
Angelegt.
updated_at
datetimenur lesbar
Zuletzt geändert.
Filter
type
post | news | announcement | promotion | contest
Nur diese Art.
Beispielanfrage
POST https://compania-mea.pulsika.eu/api/v1/posts
{
"type": "announcement",
"title": "Program de sărbători",
"body": "Între 24 și 26 decembrie programul este 9–14.",
"comments_enabled": true
}
Beispielantwort
{
"data": {
"id": 120,
"type": "announcement",
"title": "Program de sărbători",
"body": "Între 24 și 26 decembrie programul este 9–14.",
"author": "Maria Matei",
"comments_enabled": true,
"comments_count": 3,
"published_at": "2026-05-01T08:00:00Z",
"created_at": "2026-05-01T08:00:00Z",
"updated_at": "2026-05-01T08:00:00Z"
}
}
Artikel der Wissensdatenbank /knowledge-articles
Die veröffentlichten Artikel der Wissensdatenbank (Abläufe, Anleitungen), mit dem Text als reinem Text, in der angefragten Sprache (Accept-Language) oder der des Unternehmens.
Die Personen, die das Unternehmen betreut – Kunden und Interessenten. Eine E-Mail ist im Unternehmen eindeutig (eine zweite wird abgelehnt). Die Marketing-Einwilligung wird nie mit dem Eintrag geschrieben: Sie ändert sich nur über die Aktion consent, die ihren Verlauf festhält (erteilt oder widerrufen, wie, wann, von wem). Die Aktion erase löscht die Daten einer Person auf ihren Wunsch und kann nicht rückgängig gemacht werden: Name, E-Mail, Telefon, Notizen und was über sie geschrieben wurde, verschwinden, die Zahlen (Käufe, Werte von Verkaufschancen, Bewertungen) bleiben, und der Eintrag kann nicht mehr geändert werden.
Die Unternehmen und Einrichtungen, an die das Unternehmen verkauft. Der Name ist im Unternehmen eindeutig. Beim Löschen bleiben ihre Kontakte und Verkaufschancen erhalten, ohne die Verknüpfung.
Die Pipelines, die Verkaufschancen durchlaufen, mit ihren Phasen (in der Anwendung eingerichtet). Jedes Unternehmen hat eine Standard-Pipeline. Eine Phase ist offen (mit der Chance, dass eine Verkaufschance dort gewonnen wird) oder schließt sie als gewonnen oder verloren ab.
Berechtigungen: crm_pipelines:read
Endpunkte
GET/api/v1/crm-pipelinesListe
GET/api/v1/crm-pipelines/{id}Ein Eintrag
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
name
stringnur lesbar
Name.
is_default
booleannur lesbar
Ob neue Verkaufschancen hierher gehen, wenn keine Pipeline angegeben ist.
sort
integernur lesbar
Position in Listen.
stages
arraynur lesbar
Ihre Phasen in Reihenfolge: id, name, kind (open, won oder lost), probability (0–100) und sort.
Verkäufe, Buchungen oder Verträge, die eine Pipeline durchlaufen. Pipeline und Phase werden beim Anlegen gewählt (weggelassen: die erste offene Phase der Standard-Pipeline); danach wechselt eine Verkaufschance die Phase nur über move, win, lose und reopen. Ihr Status folgt immer ihrer Phase, und closed_at wird beim Gewinnen oder Verlieren gesetzt. Eine gewonnene Verkaufschance macht ihren Kontakt zum Kunden.
Berechtigungen: crm_deals:read, crm_deals:write
Endpunkte
GET/api/v1/crm-dealsListe
GET/api/v1/crm-deals/{id}Ein Eintrag
POST/api/v1/crm-dealsAnlegen
PATCH/api/v1/crm-deals/{id}Ändern
DELETE/api/v1/crm-deals/{id}Löschen
POST/api/v1/crm-deals/{id}/moveDie Verkaufschance in eine andere Phase verschieben (ihrer Pipeline oder einer anderen – die Verkaufschance wechselt mit).
POST/api/v1/crm-deals/{id}/winDie Verkaufschance als gewonnen markieren (die Gewinnphase ihrer Pipeline).
POST/api/v1/crm-deals/{id}/loseDie Verkaufschance als verloren markieren (die Verlustphase ihrer Pipeline), mit Grund.
POST/api/v1/crm-deals/{id}/reopenEine abgeschlossene Verkaufschance in die letzte offene Phase ihrer Pipeline zurückholen.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
title
stringerforderlich
Was verkauft wird.
pipeline_id
integer
Die Pipeline (siehe /crm-pipelines). Nur beim Anlegen festgelegt.
stage_id
integer
Die Phase. Nur beim Anlegen festgelegt; danach über die Aktionen.
status
open | won | lostnur lesbar
open, won oder lost – die Art ihrer Phase.
contact_id
integer | null
Der Kunde (siehe /crm-contacts).
account_id
integer | null
Die Organisation (siehe /crm-accounts).
value
number | null
Was sie wert ist.
currency
string
Die Währung des Werts (ISO-Code); weggelassen: die CRM-Währung des Unternehmens.
Was mit Kunden getan wurde oder zu tun ist: Anruf, Besprechung, Besuch, E-Mail, Notiz, Aufgabe und Kauf. Eine Aufgabe wartet, bis sie erledigt ist; alles andere ist beim Erfassen erledigt (zu done_at, falls angegeben). Ein Kauf braucht seinen Betrag und macht seinen Kontakt zum Kunden. Eine Aktivität einer Verkaufschance übernimmt deren Kunde, Organisation und Standort, wenn sie nicht angegeben sind.
Was Kunden gesagt haben: Feedback (eine Bewertung von 0–10 – wie wahrscheinlich sie das Unternehmen weiterempfehlen – und/oder ein Kommentar) und Reklamationen. Feedback braucht eine Bewertung oder einen Kommentar. Eine Reklamation bleibt offen, bis sie mit dem Getanen erledigt ist; sie kann wieder geöffnet werden. Die Art wird beim Anlegen festgelegt.
Die Hersteller und Marken, deren Kampagnen auf die Präsentationsflächen und in die Regale des Unternehmens kommen: eine Liste für beide Module. Ein Name ist im Unternehmen eindeutig. Schreiben erfordert, dass die Person, die den Schlüssel angelegt hat, „Handelspartner verwalten“ darf.
Flächen im Geschäft: die Zonenarten, die das Unternehmen an vielen Standorten hat (ein Klapprahmen, ein Thekenaufsteller, ein Totem), mit ihren üblichen Maßen und ihrer Kapazität. Den Monatspreis schreibt nur, wer Beträge sieht.
Flächen im Geschäft: die Zonen jedes Standorts (wo, wie groß, wie viel auf jede Seite passt), nur an den Standorten, die die Person gestaltet, die den Schlüssel angelegt hat. Eine Zone bleibt an ihrem Standort. Eine neue Zone einer Art übernimmt für Fehlendes die Maße der Art. Weniger Seiten oder weniger Platz, als ihre laufenden Kampagnen brauchen, wird abgelehnt; eine Zone mit Kampagnen kann nicht gelöscht werden.
Regalflächen: die Arten von Möbeln (eine Gondel, eine Stirnseite, ein Kühlregal) mit der Preisliste – pro Produkt-Facing oder pro Regalmeter, pro Monat. Preise schreibt nur, wer das Recht für Regalpreise hat.
Regalflächen: einmal beschriebene Planogramme – das Möbel, die Maße, die Regalböden von oben nach unten mit dem, was auf jeden passt (Facings oder Zentimeter), und ihrem Preisfaktor. Gesendete Regalböden ersetzen die Liste der Regalböden; ein Regalboden mit Kampagnen kann nicht entfernt werden. Ein Name ist eindeutig.
Regalflächen: ein an einem Standort aufgestelltes Planogramm mit eigener Bezeichnung, Notiz und Kosten, nur an den Standorten, die die Person gestaltet, die den Schlüssel angelegt hat. Löschen entfernt es vom Standort: für den Verlauf seiner Kampagnen aufbewahrt oder ganz entfernt, wenn es keine hatte; nie, solange darauf eine Kampagne läuft. Kosten schreibt nur, wer Preise sieht.
Kampagnen beider Module (module: spaces – Präsentationszonen; shelf – Regalböden von Planogrammen), geschrieben als die Person, die den Schlüssel angelegt hat. Eine Kampagne beginnt als Entwurf: Ihre Standorte (units) und die Regeln, die Plätze darin nennen (rules), werden zu ihren Plätzen. Die Aktion launch prüft den Platz und sendet sie an jeden Standort; cancel stoppt sie. Eine gestartete Kampagne behält Daten und Plätze; nur Text, Partner, Beträge und die Fotopflicht ändern sich. Wert und Kosten schreibt nur, wer Beträge sieht.
POST/api/v1/merch-campaigns/{id}/launchDen Entwurf starten: Platz prüfen und an jeden Standort senden.
POST/api/v1/merch-campaigns/{id}/cancelEine gestartete Kampagne stornieren: Sie beginnt nicht, wo sie nicht aufgebaut wurde, und wird abgebaut, wo sie steht.
Felder
Name
Typ
Beschreibung
id
integernur lesbar
Kennung.
module
spaces | shelferforderlich
spaces oder shelf – nur beim Anlegen.
title
stringerforderlich
Titel der Kampagne.
partner_id
integer | null
Der zahlende Partner (siehe /merch-partners); leer: eigene Kampagne des Unternehmens.
instructions
text | null
Anleitung zur Umsetzung (formatierter Text, bereinigt).
starts_on
dateerforderlich
Erster Tag.
ends_on
dateerforderlich
Letzter Tag.
implement_days
integer
Tage, die ein Standort ab Beginn zum Aufbauen hat.
remove_days
integer
Tage, die ein Standort nach dem Ende zum Abbauen hat.
proof_required
boolean
Ob ein Standort beim Bestätigen Fotos senden muss.
value
number | null
Was der Partner für die ganze Kampagne zahlt, ohne Umsatzsteuer.
cost
number | null
Was sie das Unternehmen kostet (Material, Aufbau), ohne Umsatzsteuer.
currency
stringnur lesbar
Die Währung der Beträge (aus den Einstellungen des Moduls).
Die Regeln, die Plätze nennen, zusammen mit units. spaces: [{zone_type_id oder zone_id, face (A/B), quantity}]; shelf: [{planogram_id oder placement_id, position (Regalboden, von oben), quantity, products}].
targets
arraynur lesbar
Die sich ergebenden Plätze: pro Standort Zone und Seite oder Aufstellung und Regalboden, mit der Menge.
Eine gestartete Kampagne an einem Standort: wer sie aufbaut und bis wann, ob sie steht, abgelehnt wurde (mit Grund), abgebaut wird oder erledigt ist. Aktionen erfolgen als die Person, die den Schlüssel angelegt hat (die dort umsetzt oder, bei reopen, die Kampagne verantwortet). Fotos werden als Base64-Bilder gesendet; eine Kampagne, die sie verlangt, kann ohne sie nicht bestätigt werden.
Diese Website verwendet nur die Cookies, die sie zum Funktionieren braucht. Seitenaufrufe zählen wir ohne Cookies und ohne Sie zu identifizieren. Cookie-Richtlinie