Integration WoltLab Upload API für automatisierte Releases #309

Quote

Der Endpunkt lautet: /1.0/vendor/file/add.json. Erwartet wird wie bei den anderen API-Endpunkten ein POST-Request, der durch PHP verarbeitet werden kann.

Folgende Felder sind verfügbar (und notwendig):

• apiKey: Bekannt aus RE: WoltLab API
• vendorID: Dito.
• fileID: Dito.
  • Achtung: Durch die Mehrsprachigkeit ist die ID in der Adressleiste nicht die korrekte. Der „Share“-Button liefert im BBCode die korrekte ID.
• versionNumber: Dito.
• description_de: Deutsche Beschreibung. Läuft durch den HtmlInputProcessor, entsprechend muss hier HTML gesendet werden, wie es auch aus dem Editor kommen würde.
• description_en: Analog.
• filename: Der Dateiname. Wird durch den regulären Ausdruck /^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+(_[a-zA-Z0-9_]+)?\.(tar|tar\.gz)$/ validiert. Anders gesagt: Package-Identifier, Unterstrich, Versionsnummer, Dateiendung.
• payload: base64-kodierter Dateiinhalt.

Als Antwort gibt es dann JSON mit:

• versionID: Bekannt aus RE: WoltLab API
• fileHash: Dito.
• versionNumber: Dito.

Eine gültige Anfrage sieht dann etwa so aus (wenn wir mal ignorieren, dass foo kein gültiger Dateiinhalt ist):

HTTP

Code

POST /1.0/vendor/file/add.json HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 186
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: api.woltlab.com
User-Agent: HTTPie/1.0.3

apiKey=123&vendorID=1336766&fileID=30&versionNumber=1.0.0&description_de=%3Cp%3Efoo%3C%2Fp%3E&description_en=%3Cp%3Ebar%3C%2Fp%3E&filename=com.example.test_1.0.0.tar&payload=Zm9vCg%3D%3D

Ein gültiger Guzzle-Request kann (ungetestet) wie folgt erzeugt werden:

PHP

Code

$payload = [
  'apiKey' => 123,
  'vendorID' => 1336766,
  'fileID' => 30,
  'versionNumber' => '1.0.0',
  'description_de' => '<p>foo</p>',
  'description_en' => '<p>bar</p>',
  'filename' => 'com.example.test_1.0.0.tar',
  'payload' => Base64::encode(file_get_contents(…)), // ParagonIE\ConstantTime\Base64 wird am Server genutzt, weil die Validierung besser ist.
];
  
$request = new Request('POST', 'https://api.woltlab.com/1.0/vendor/file/add.json', [
  'accept' => 'application/json',
  'content-type' => 'application/x-www-form-urlencoded',
  'user-agent' => HttpFactory::getDefaultUserAgent(Email::getHost()),
], \http_build_query($payload,

Display More

Display More