REST PageSpeed-Tool

Das PageSpeed-Tool gruppiert JavaScript- und CSS-Dateien, minimiert sie und exportiert sie in den Shop. Über diese Schnittstelle lösen Sie den Build aus und verfolgen seinen Verlauf, beispielsweise als letzten Schritt eines Deployments. Beide Aufrufe brauchen ein Token, siehe REST-Authentifizierung. Content-Type ist application/json.

Build starten

POST https://www.websale.de/api/pagespeedtool/build

Eigenschaft	Typ	Beschreibung
`type`	string	Welche Gruppen generiert werden sollen. Pflichtfeld. Mögliche Werte: `js` oder `css`.

{
    "type": "js"
}

Mit curl, hier für die CSS-Gruppen:

curl \
 -X POST \
 -H "Content-Type: application/json" \
 -H "X-Authorization: Bearer eyJhbGciOiJIUzI1Ni...jBhOWMyMmRmNzFkOT==" \
 -d '{
    "type": "css"
}' \
"https://www.websale.de/api/pagespeedtool/build"

Bei Erfolg antwortet der Server mit HTTP-Code 200 und leerem Inhalt.

Status-Code	Bedeutung	Beschreibung
400	Bad Request	Ungültiger Content-Type oder falsches Format beziehungsweise falscher Inhalt des Request-Body
401	Unauthorized	Keine Berechtigung für die ShopID oder Token abgelaufen
409	Conflict	Es läuft bereits ein Build-Prozess

Weil JavaScript und CSS getrennt gebaut werden, brauchen Sie zwei Aufrufe. Starten Sie sie nacheinander, sonst läuft der zweite in einen 409.

Status abfragen

GET https://www.websale.de/api/pagespeedtool/status

Ein Request-Body ist nicht nötig.

curl \
 -X GET \
 -H "Content-Type: application/json" \
 -H "X-Authorization: Bearer eyJhbGciOiJIUzI1Ni...jBhOWMyMmRmNzFkOT==" \
"https://www.websale.de/api/pagespeedtool/status"

Feld	Typ	Beschreibung
`status`	String	`running`, `error` oder `finished`
`progress`	Integer	Fortschritt in Prozent
`packages`	Integer	Anzahl der Pakete, die verarbeitet werden
`finished`	Integer	Anzahl der bereits verarbeiteten Pakete
`package`	Array	Detailinformationen zu allen Paketen
`package[].id`	String	ID des Pakets
`package[].status`	String	`ok`, `bundle-error`, `minify-error` oder `error`
`package[].changed`	Bool	Ob sich das Paket seit der letzten Generierung inhaltlich geändert hat
`package[].error`	Array oder Object	Bei `bundle-error` die Liste der nicht gefundenen Ressourcen, bei `minify-error` ein Objekt mit Details zum Syntaxfehler
`package[].error.resource`	String	Ressource, in der der Syntaxfehler gefunden wurde
`package[].error.line`	String	Zeile des Syntaxfehlers
`package[].error.pos`	String	Position des Syntaxfehlers
`package[].error.msg`	String	Beschreibung des Syntaxfehlers

Die Paketstatus im Einzelnen:

Status	Bedeutung
`ok`	Paket wurde erfolgreich gebaut
`bundle-error`	Es konnten nicht alle Ressourcen geladen werden
`minify-error`	Syntaxfehler innerhalb einer Ressource
`error`	Das Ergebnis konnte nicht gespeichert werden

{
  "status": "finished",
  "progress": 100,
  "packages": 4,
  "finished": 4,
  "package": [
    {
      "id": "package1",
      "status": "ok",
      "changed": true,
      "type": "js"
    }
  ]
}

Status-Code	Bedeutung	Beschreibung
401	Unauthorized	Keine Berechtigung für die ShopID oder Token abgelaufen
404	Not Found	Es läuft aktuell kein Build-Prozess

Die Statusabfrage liefert nur so lange eine gültige Antwort, bis der Build abgeschlossen ist und die Meldung finished oder error einmal abgerufen wurde. Danach antwortet sie mit 404. Holen Sie das Ergebnis also ab und werten Sie es sofort aus, ein zweiter Abruf liefert es nicht erneut.

Schnittstellen

Build starten

Status abfragen

Verwandte Themen

​Build starten

​Status abfragen

​Verwandte Themen

Build starten

Status abfragen

Verwandte Themen