2016-08-08 9 views
-1

Ich bin ein Anfänger bei der Verwendung von APIs. Aufgrund meiner Arbeit muss ich lernen, Autopilothq zu verwenden. Es gibt auch eine API für diese, die in JavaScript ist:API für Autopilot

http://developers.autopilothq.com/

Aber meine Frage ist im Grunde, wie implementiere ich all diese Funktionen? Muss ich eine Administrations-Site erstellen, auf der ich diese Funktionen implementiere, oder oft im Online-Programm selbst, von dem sie aufgerufen werden?

Zum Beispiel in der Konsole ihrer Website Autopilot, kann ich folgendes eingeben:

var sessionId = AutopilotAnywhere.sessionId; 
sessionId; 

Dann bekomme ich eine 24-stellige Nummer. Diese Nummer kann an eine contact_id angehängt werden. Aber wie führe ich diese Codezeile auf einer Site aus? Soll ich einfach eine JS-Datei erstellen und meine Funktionen hier eingeben, dann rufe das Skript vom head-Tag aus auf?

Aktualisiert Frage: Image on JavaScript

+0

Die Autopilot-API scheint nicht in JavaScript zu sein, es ist REST. –

+0

Danke. Ich könnte nur auf den folgenden Link sehen: http://docs.autopilot.apiary.io/#reference/api-methods/bulk-add-contacts/bulk-add-contacts, dass Sie Javascript-Aufrufe machen könnten. Ist es das gleiche Prinzip, dass ich ein Skript auf der Site machen muss, oder? –

+0

Ich sehe nicht, wo Sie JavaScript-Aufrufe auf dieser Seite machen können ... –

Antwort

3

Wenn Sie JavaScript verwenden, um ihre API zuzugreifen, können Sie ein HTML-Dokument erstellen, das einen JavaScript-Skript enthält, das macht eine XMLHttpRequest (Ajax) Anforderung an ihren REST -API mit einigem Code wie die aus dem Beispiel in deinem Screenshot.

Sie müssen Ihren privaten API-Schlüssel angeben (er fungiert als eine Art Benutzername und Passwort in einer Sache), damit das Skript auf Ihr Konto zugreifen kann. Dann erstellen Sie einen Anfragetext und verwenden eine HTTP-Methode, um Ihre Anfrage zu senden (siehe CRUD). Die API gibt dann eine JSON-codierte Zeichenfolge (oder einen Fehler) zurück, mit der Sie in Ihrem Skript arbeiten können.

Also, im Grunde können Sie eine administrative Website erstellen, die einige Funktionen implementiert, um Änderungen an Ihrem Konto (oder was auch immer die API Ihnen erlaubt) vorzunehmen. Aber eine API ermöglicht Ihnen viel mehr, da sie mit fast jeder Programmiersprache verwendet werden kann, so dass Sie auch eine native mobile oder Desktop-App erstellen können. Sie können Benutzern auch erlauben, etwas wie unsubscribe themselves zu tun, wenn die API Ihnen erlaubt, API-Schlüssel mit bestimmten Einschränkungen zu erstellen (d. H. Nur die Abmeldeaktion mit dem vom Benutzer verwendeten Schlüssel zulassen).

Denken Sie daran, Ihren API-Schlüssel nicht offenzulegen. Wenn Sie eine Website erstellen, die mit der API arbeiten soll, stellen Sie sicher, dass der Schlüssel nicht in Ihrem Skript gespeichert wird, da jeder die Quelldatei anzeigen kann. Stattdessen können Sie den Schlüssel entweder nach einer erfolgreichen Anmeldung über PHP bereitstellen oder sich das serverseitige JavaScript ansehen (z. B. Node.js) oder an etwas anderes denken.

+1

+1 für die Warnung des Benutzers, seinen/ihren API-Schlüssel vor Benutzern zu verbergen. Ein häufiger Fehler für Neulinge, die ihre Zugangsdaten im Code für alle sichtbar hinterlassen. – Jorrex

+0

Vielen Dank für Ihre Antwort hier. Das hat mir sehr geholfen. Ich werde versuchen, eine Admin-Seite zu erstellen, mit etwas Javascript und auch REST. Oft wundert es mich, warum es keine Beispiele gibt, wie man die API benutzt.Fx der Abschnitt: "Suche die Session-ID mit Javascript im Browser": "docs.autopilot.apiary.io/#reference/api-methods/...; Ich denke, dass ich ein wenig hier raten muss. Aber okay, Kopieren/Einfügen ist auch kein guter Weg. Vielen Dank :) –