Simply CRM Web Service & API-Dokumentation

Diese Dokumentation beschreibt die von Simply CRM veröffentlichte REST-basierte Anwendungsprogrammierschnittstelle (API). Es ist als Referenzdokument für alle gedacht, die unsere APIs verwenden.

Wir empfehlen, dass Sie das Lernprogramm durchgehen, bevor Sie versuchen, diese Dokumentation zu lesen.

Alle Strukturdaten einschließlich der Antwort von der API werden als JSON-Zeichenfolgen dargestellt.

Jede Entität verfügt über eine speziell formatierte ID, mit der der Typ einer Entität und der Datensatz nachgeschlagen werden können. Erstellen ist der einzige Fall, für den keine ID erforderlich ist.

 http: //Simply_url/webservice.php? operation = [Operationstyp] & sessionName = [Sitzungsname] & [operationenspezifische Parameter]

Derzeit unterstützt Simply CRM die folgenden Vorgänge:

  • getchallenge
  • Anmeldung
  • erstellen
  • abrufen
  • aktualisieren
  • löschen
  • synchronisieren
  • Abfrage
  • Listentypen
  • beschreiben
  • Ausloggen
  • Extensession

Sitzungsname

Der Schlüssel, mit dem die aktuelle Sitzung eindeutig identifiziert wird. Diese Informationen sollten im Rahmen jeder Anforderung an den Server gesendet werden.

Internetservice

Die Webdienst-API unterstützt das Sicherheitsmodell, das in der Simply-Webbenutzeroberfläche befolgt wird.

Der Anmeldevorgang verwendet ein zweistufiges Challenge / Response-Schema.

Von der API verwendete Datentypen

Alle Antworten haben das unten gezeigte Format. Wenn die Anfrage erfolgreich verarbeitet wurde, lautet das Format:

Wenn während der Verarbeitung der Anforderung ein Fehler auftritt, erhalten Sie das folgende Antwortformat:

 Antwort {
Erfolg: Boolean = true
Ergebnis: Objekt // Das Ergebnisobjekt
}}
 Antwort {
Erfolg: Boolean = false
Fehler: ErrorObject
}}
 ErrorObject {
errorCode: String // String-Darstellung des Fehlertyps
errorMessage: String // Fehlermeldung von der API
}}

ErrorCode ist eine Zeichenfolgendarstellung des Fehlertyps.

SimplyObject

SimplyObject ist eine Karte, die den Inhalt eines auf crm-Entitäten basierenden Objekts darstellt. Alle Referenzfelder verwenden den ID-Typ, der jedem Objekt eine eindeutige Nummer zuweist. Dieses Feld ist für alle aus der Datenbank abgerufenen Objekte vorhanden.

ID-Format

 objectTypeId 'x' objectId

objectTypeId - ID des Objekttyps. Dies wird für jede von der Webdienst-API unterstützte Entität eindeutig generiert und im Ergebnis der Beschreibung als idPrefix zurückgegeben.

objectId - ID des Objekts in der Datenbank. Dies ist eine global eindeutige ID für Objekte der angegebenen Entität.

Karte

Ein assoziatives Array von Schlüsselwertpaaren. Wird normalerweise beim Erstellen verwendet.

Zeitstempel

Eine lange Darstellung der Anzahl der Sekunden seit der Unix-Epoche.

Operationen

Einloggen

Die Anmeldung erfolgt in zwei Schritten: Zuerst generieren wir ein eindeutiges Token, das getChallenge aufruft. Verwenden Sie dann dieses Token und unseren eindeutigen Zugriffsschlüssel, um eine Sitzungs-ID zu generieren, die wie eine Authentifizierungskennung fungiert.

Herausforderung erhalten

Wird verwendet, um ein Challenge-Token vom Server abzurufen.

Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know. Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know. Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know.

Dies muss eine POST-Anfrage sein.

URL-Format

 http: //Simply_url/webservice.php? operation = extensession

CRM-Entitäten

Was folgt, ist die Liste der CRM-Entitäten, die von der API verfügbar gemacht werden.

Name Beschreibung
Kalender Das Kalendermodul wird zum Verwalten von Aufgaben, Ereignissen und Besprechungen verwendet.
Führt Das Leads-Modul wird verwendet, um Sales Leads zu verfolgen.
Konten Das Modul "Konten" wird zum Verwalten von Personen oder Organisationen verwendet, die an Ihrem Unternehmen beteiligt sind.
Kontakte Das Modul "Kontakte" wird zum Verwalten von Personen verwendet, die einem Konto zugeordnet sein können.
Potenziale Das Modul Potenziale wird zum Verwalten von Verkaufschancen verwendet.
Produkte Das Produktmodul wird zum Verwalten der Produkte verwendet, die Ihre Organisation verkauft.
Unterlagen Das Modul Dokumente wird zum Verwalten der hochgeladenen Dokumente und Notizen verwendet.
E-Mails Das E-Mail-Modul ist ein E-Mail-Client, mit dem Sie Ihre E-Mails verwalten können.
Beratungsstelle Das HelpDesk-Modul wird verwendet, um Kundenprobleme wie Feedback, Probleme usw. zu verfolgen.
FAQ Das FAQ-Modul wird verwendet, um die häufig gestellten Fragen Ihrer Kunden zu verwalten.
Anbieter Das Vendors-Modul wird zum Verwalten von Herstellern und Herstellern verwendet.
Preisbücher Das PriceBook-Modul wird zum Verwalten der Preisgestaltung von Produkten verwendet.
Zitate Das Modul Angebote wird zum Verwalten von Produktangeboten verwendet.
Bestellung Das PurchaseOrder-Modul dient zur Verwaltung und Bearbeitung der Bestellungen.
SalesOrder Das SalesOrder-Modul wird zum Verwalten und Verarbeiten von Verkaufsaufträgen verwendet.
Rechnung Mit dem Rechnungsmodul werden Rechnungsberichte erstellt.
Kampagnen Das Modul Kampagnen wird zum Verwalten von Marketingkampagnen verwendet.
Veranstaltungen Das Ereignismodul wird zum Verwalten von Aktivitäten wie Anrufen und Besprechungen verwendet.
Benutzer Das Benutzermodul wird zum Verwalten der CRM-Benutzer verwendet.
Gruppen Benutzergruppen in Simply CRM .
Währung Mit dem Währungsmodul kann der Administrator verschiedene Währungen definieren und die erwarteten Umrechnungskurse in Bezug auf die Basiswährung festlegen. Diese Währungen können im Inventarmodul zur Unterstützung mehrerer Währungen verwendet werden.
DocumentFolders Das DocumentFolders-Modul wird zum Gruppieren von Dokumenten verwendet.

Feldtypen

Auswahlliste

Ein Feld, das eine Liste von Werten enthalten kann. In diesem Fall enthält die Karte zwei Elemente: picklistValues, eine Liste möglicher Werte, und defaultValue, den Standardwert für die Auswahlliste.

Name Beschreibung
picklistValues Stellt die Liste möglicher Werte dar.
Standardwert Gibt an, welcher Wert als Standardwert für die Auswahlliste verwendet werden soll.
Name Der Name des Feldtyps.

Referenz

Ein Feld, das eine Beziehung zu einem anderen Objekt anzeigt. Die Feldtypzuordnung enthält ein weiteres Element namens referenzTo, ein Array, das die Module enthält, auf die das Feld verweisen kann.

Name Beschreibung
bezieht sich auf Ein Array mit den Modulen, auf die das Feld verweisen kann.
Name Der Name des Feldtyps.

Terminzeit

Das Format ist eine Zeichenfolge, die Datum und Uhrzeit darstellt. Es basiert auf dem Datumsformat der Benutzereinstellungen.

Datum

Eine Zeichenfolge, die ein Datum darstellt. Die Feldtypzuordnung enthält ein weiteres Element namens Format , das das erwartete Format des Feldwerts basierend auf den Datumsformateinstellungen des Benutzers angibt.

Name Beschreibung
Format Das erwartete Format des Feldwerts.
Name Der Name des Feldtyps.

Text

Ein mehrzeiliges Textfeld.

Zeit

Eine Zeichenfolge mit dem Format hh: mm, die auf den Zeitformateinstellungen des Benutzers basiert.

String

Ein einzeiliges Textfeld.

Boolescher Wert

Ein boolesches Feld, das nur die Werte true oder false haben kann .

Ganze Zahl

Ein nicht dezimales Zahlenfeld.

Inhaber

Ein Feld, mit dem der Eigentümer des Felds definiert wird. Dies kann eine Gruppe oder ein einzelner Benutzer sein.

Automatisch generiert

Felder wie die Objekt-ID, deren Werte von Simply automatisch generiert werden.

Email

Ein Feld zum Speichern von E-Mail-IDs.

Telefon

Ein Feld zum Speichern von Telefonnummern.

URL

Ein Feld zum Speichern von URLs.

Doppelt

Ein Feld für Gleitkommazahlen.

Datei

Ein Feld zum Hinzufügen von Dateien zu Simply.

Name Beschreibung
maxUploadFileSize Die maximal zulässige Größe zum Hochladen von Dateien.
Name Der Name des Feldtyps.

Passwort

Ein Feld zum Speichern von Passwörtern.

Dezimal

Ein Feld für Gleitkommazahlen.

Skype

Ein Feld zum Speichern von Skype-IDs oder Telefonnummern.

Multipickliste

Ein Auswahllistenfeld, in dem mehrere Werte ausgewählt werden können.

Bekannte Probleme

Die Synchronisierung funktioniert nicht im Benutzermodul und in Nicht-Entitätsmodulen wie Währung, Gruppen usw.

Die Abfrage funktioniert nicht bei Nicht-Entitätsmodulen wie Währung, Gruppen usw.

Aktualisiert am 18/11/2020

War dieser Artikel hilfreich?

In Verbindung stehende Artikel