Page tree
Skip to end of metadata
Go to start of metadata

Beschreibung

Dies ist die zweite Version der SOAP-API. Diese wurde hinzugefügt, um ein leichteres Arbeiten zu ermöglichen, da mit der Implementierung der SOAP-Api v1 keine optionale Angabe von Informationen in Requests möglich ist. Es soll somit ermöglicht werden, dass Sie nur die Angaben im Request vornehmen müssen, die wichtig sind. Sie haben somit in Ihrer Implementierung unserer SOAP-Api weniger Aufwand, wenn Sie einen minimalen Aufruf machen wollen.

Endpoint

Um mit Ihrem auf SOAP Client die BACKCLICK API anzusprechen benötigen Sie die API Definition. Diese nennt sich WSDL. 
Die WSLD-Definition dieser API ist abhängig von der bei Ihnen installierten Version von BACKCLICK.
Die wsdl Defnition Ihrer BACKCLICK Instanz/Installation finden Sie unter folgender URL (api-server.ihre-backclick-domain.tld ersetzen Sie bitte durch die Domain Ihrer Installation):

  • http(s)://api-server.ihre-backclick-domain.tld/bc/rpc/soap/backclickService.wsdl

WSDL Beispiel der BACKCLICK Mietlösung (SaaS) -
(bitte nicht verwenden wenn Sie eine On Premise Installation oder oder eine exclusive managed Cloud Lösung verwenden) 
 
Die nachfolgende WSDL Definition muss von allen BACKCLICK SaaS verwendet werden.
 


Authentifizierung / Security

Die Berechtigung, die SOAP-Api zu benutzen, ist auf freigeschaltete IP-Adressen oder einen gültigen API-Key beschränkt. Sollen Sie keine Berechtigung haben die Schnittstelle zu verwenden, dann bekommen Sie einen Fehler (SOAP-Fault) angezeigt. In diesem Fall wenden Sie sich bitte an Ihren Administrator von Backclick und bitten ihn, Ihre IP freizuschalten oder Ihnen den API-Key geben zu lassen. Ein solcher Fehler sieht in etwa folgendermaßen aus:

IP [xxx.xxx.xxx.xxx] is not allowed to access this service.


Hinweise

  • Alle Veränderungen, die Sie durch die API vornehmen, können nicht rückgängig gemacht werden.
  • Bitte benutzen Sie eine fehlertolerante Implementierung unserer Funktionen, um Fehlern wegen Nichtverfügbarkeit (z.B.: Wartungsarbeiten, Routingproblemen oder allgemeiner Ausfallzeit) unserer API vorzubeugen.

Themen