Diese Dokumentation beschreibt die REST-basierte Anwendungsprogrammierschnittstelle (die API), die von Simply CRM . Es ist als Referenzdokument für alle gedacht, die unsere APIs verwenden.
Wir empfehlen Ihnen, das Tutorial durchzugehen, bevor Sie versuchen, diese Dokumentation zu lesen.
Alle strukturellen Daten einschließlich der Antwort von der API werden als JSON-Strings dargestellt.
Jede Entität hat eine speziell formatierte ID, die verwendet werden kann, um den Typ einer Entität und den Datensatz nachzuschlagen. Create ist der einzige Fall, für den keine ID erforderlich ist.
http://Simply_url/webservice.php?operation= [Vorgangstyp]&sessionName=[Sitzungsname]&[Vorgangsspezifische Parameter]
Derzeit unterstützt Simply CRM die folgenden Vorgänge:
- Getchallenge
- Anmeldung
- erstellen
- abrufen
- aktualisieren
- löschen
- synchronisieren
- Abfrage
- Listentypen
- beschreiben
- Ausloggen
- Sitzung verlängern
Sitzungsname
Der Schlüssel, der verwendet wird, um die aktuelle Sitzung eindeutig zu identifizieren. Diese Informationen sollten als Teil jeder Anfrage an den Server gesendet werden.
Internetservice
Die Webservice-API unterstützt das Sicherheitsmodell, das in der Simply Web-Benutzeroberfläche verfolgt wird.
Der Login-Prozess 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:
Tritt während der Bearbeitung der Anfrage ein Fehler auf, erhalten Sie folgendes Antwortformat:
Antwort {
Erfolg:Boolean=true
result:Object //Das Result-Objekt
} Antwort {
Erfolg:Boolean=false
error:ErrorObject
} FehlerObjekt {
errorCode:String //String-Darstellung des Fehlertyps
errorMessage:String //Fehlermeldung von der API
}ErrorCode ist eine Zeichenfolgendarstellung des Fehlertyps.
EinfachObjekt
SimplyObject ist eine Map, die den Inhalt eines auf einer CRM-Entität 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 geholten Objekte vorhanden.
ID-Format
objectTypeId 'x' objectId
objectTypeId - ID des Objekttyps. Dies wird eindeutig für jede Entität generiert, die von der Webdienst-API unterstützt wird, und im Ergebnis des Beschreibungsvorgangs 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üssel-Wert-Paaren. Wird normalerweise in der Erstellungsoperation verwendet.
Zeitstempel
Eine lange Darstellung der Anzahl der Sekunden seit der Unix-Epoche.
Betrieb
Anmeldung
Die Anmeldung erfolgt in zwei Schritten: Zuerst generieren wir einen eindeutigen Token, der getChallenge aufruft. Verwenden Sie dann dieses Token und unseren eindeutigen Zugriffsschlüssel, um eine Sitzungs-ID zu generieren, die wie eine Authentifizierungskennung wirkt.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
URL-Format
http://Simply_url/webservice.php?operation=query&sessionName= [Sitzungs-ID]&query=[Abfragezeichenfolge]
Synchronisieren
Sync gibt ein SyncResult-Objekt zurück, das Details zu Änderungen nach ModifiedTime enthält.
sync(modifiedTime: Timestamp, elementType: String): SyncResult
Anfrage
Typ : GET
modifiziertTime: Die Zeit der letzten synchronisierten Änderung.elementType: Dies ist ein optionaler Parameter, falls angegeben, werden die Änderungen für dieses Modul nach der angegebenen Zeit zurückgegeben, andernfalls werden Änderungen an allen vom Benutzer zugänglichen Modulen zurückgegeben.
Antwort
SyncResult { updated:[Object] //List of Objects created or modified. deleted:[Id] //List of *Id* of objects deleted. lastModifiedTime:Timstamp //time of the latest change. which can used in the next call to the Sync api to get all the latest changes that the client hasn't obtained. }Dies muss eine GET-Anfrage sein.
URL-Format
http://Simply_url/webservice.php?operation=sync&sessionName= [Sitzungs-ID]&modifiedTime=[Zeitstempel]&elementType=[elementType]
Ausloggen
Melden Sie sich von der Webservice-Sitzung ab, wodurch die Webservice-Sitzung für die weitere Verwendung ungültig wird.
logout(): Karte
Request Type: GET Gibt eine Map mit dem Schlüssel 'message' mit dem Wert 'successful' zurück.
Dies muss eine GET-Anfrage sein.
URL-Format
http://Simply_url/webservice.php?operation=logout&sessionName= [Sitzungs-ID]
Listentypen
Listen Sie die Namen aller Simply-Objekte auf, die über die API verfügbar sind.
listtypes(): Karte
Anfragetyp: GET
Gibt eine Map zurück, die den Schlüssel 'Typen' enthält, wobei der Wert eine Liste von Namen von Simply-Objekten ist.
Dies muss eine GET-Anfrage sein.
URL-Format
http://Simply_url/webservice.php?operation=listtypes&sessionName= [Sitzungs-ID]
Beschreiben
Rufen Sie die Typinformationen zu einem bestimmten Simply-Objekt ab.
describe(elementType: String): DescribeResult
Anfragetyp: GET
elementType: Der Typname des zu beschreibenden Simply-Objekts.
Gibt eine DescribeResult-Instanz zurück.
Dies muss eine GET-Anfrage sein.
URL-Format
Sitzung verlängern
Erweitert die aktuelle Simply Web-Sitzung auf den Webservice und gibt die Sitzungs-ID des Webservices zurück.
Extendsession(Benutzername:String): LoginResult
Anfragetyp: POST
Benutzername: Ein einfacher Benutzername.
Dies muss eine POST-Anfrage sein.
URL-Format
http://Simply_url/webservice.php?operation=extendsession
CRM-Einheiten
Was folgt, ist die Liste der CRM-Entitäten, die von der API bereitgestellt werden.
| Name | Beschreibung |
| Kalender | Das Modul Kalender dient der Verwaltung von To-Dos, Events und Meetings. |
| Führt | Das Leads-Modul wird verwendet, um Vertriebs-Leads zu verfolgen. |
| Konten | Das Modul Konten wird verwendet, um Einzelpersonen oder Organisationen zu verwalten, die an Ihrem Unternehmen beteiligt sind. |
| Kontakte | Das Modul Kontakte wird verwendet, um Personen zu verwalten, die mit einem Konto verknüpft sein können. |
| Potenziale | Das Modul Potenziale dient der Verwaltung von Verkaufschancen. |
| Produkte | Das Modul Produkte wird verwendet, um die Produkte zu verwalten, die Ihre Organisation verkauft. |
| Unterlagen | Das Modul Dokumente dient der Verwaltung der hochgeladenen Dokumente und Notizen. |
| E-Mails | Das E-Mail-Modul ist ein E-Mail-Client zur Verwaltung Ihrer E-Mails. |
| 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 Modul Lieferanten dient der Verwaltung von Herstellern und Produzenten. |
| PreisBücher | Das PriceBook-Modul wird verwendet, um die Preisgestaltung von Produkten zu verwalten. |
| Zitate | Das Angebotsmodul wird verwendet, um Produktangebote zu verwalten. |
| Bestellung | Das Modul PurchaseOrder dient der Verwaltung und Bearbeitung der Bestellungen. |
| VerkaufBestellung | Das Modul SalesOrder dient zur Verwaltung und Bearbeitung von Verkaufsaufträgen. |
| Rechnung | Das Modul Rechnung wird verwendet, um Rechnungsberichte zu erstellen. |
| Kampagnen | Das Modul Kampagnen dient der Verwaltung von Marketingkampagnen. |
| Veranstaltungen | Das Ereignismodul wird verwendet, um Aktivitäten wie Anrufe und Besprechungen zu verwalten. |
| Benutzer | Das Modul Benutzer wird verwendet, um die CRM-Benutzer zu verwalten. |
| Gruppen | Benutzergruppen in Simply CRM . |
| Währung | Das Währungsmodul ermöglicht es dem Administrator, verschiedene Währungen zu definieren und die erwarteten Umrechnungskurse in Bezug auf die Basiswährung festzulegen. Diese Währungen können im Inventarmodul verwendet werden, um mehrere Währungen zu unterstützen. |
| Dokumentenordner | Das DocumentFolders-Modul wird zum Gruppieren von Dokumenten verwendet. |
Feldtypen
Auswahlliste
Ein Feld, das einen aus einer Liste von Werten enthalten kann. In diesem Fall enthält die Karte zwei Elemente: picklistValues, eine Liste möglicher Werte, und defaultValue, der Standardwert für die Auswahlliste.
| Name | Beschreibung |
| picklistWerte | Stellt die Liste der möglichen 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 referTo, bei dem es sich um ein Array handelt, das die Module enthält, auf die das Feld zeigen kann.
Terminzeit
Eine Zeichenfolge, die Datum und Uhrzeit darstellt. Das Format 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 im Format hh:mm, die auf den Zeitformateinstellungen des Benutzers basiert.
Zeichenfolge
Ein einzeiliges Textfeld.
Boolesches
Ein boolesches Feld, das nur die Werte true oder false haben kann .
Ganze Zahl
Ein nicht dezimales Zahlenfeld.
Inhaber
Ein Feld, das verwendet wird, um den Besitzer des Felds zu definieren. Dies kann eine Gruppe oder ein einzelner Benutzer sein.
Automatisch generiert
Felder wie die ID des Objekts, deren Werte von Simply automatisch generiert werden.
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 für das 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.
Mehrfachauswahlliste
Ein Auswahllistenfeld, in dem mehrere Werte ausgewählt werden können.
Bekannte Probleme
Die Synchronisierung funktioniert nicht auf dem Benutzermodul und Nicht-Entitätsmodulen wie Währung, Gruppen usw.
Die Abfrage funktioniert nicht bei Nicht-Entitätsmodulen wie Währung, Gruppen usw.
