Zum Hauptinhalt gehen

Bureau Works API-Befehlszeile

Carlos Carvalhaes
  • Aktualisiert

Die Bureau Works CLI ist eine NodeJS-Bibliothek, die für den direkten Zugriff auf die Bureau Works-API-Aufrufe über die Befehlszeile verwendet werden kann.

Es ist möglich, Projekte zu erstellen, zu genehmigen, abzubrechen und viele andere Dienstprogramme.

Anforderungen

Damit Sie die BWX CLI verwenden können, benötigen Sie zunächst ein Bureau Works-Konto und eine API KEY. Bitte besuchen Sie https://www.bureauworks.com, um Ihr Konto zu erhalten!

Nach der Registrierung gehen Sie zu Mein Konto:

mceclip0.png

 

Klicken Sie auf "Mein Bureau Works API-Token anzeigen", um Ihre Anmeldeinformationen für den Zugriff auf unsere API zu generieren und zu erhalten: 

 

mceclip1.png

 

Außerdem müssen NodeJS und git in Ihrer Umgebung installiert sein.

Api-Referenz finden Sie in https://dev.bureau.works, dass Sie die Hauptaufrufe sehen können.

Installation

Klonen Sie unser GitHub-Repository auf https://github.com/bureauworks/bwx

• Git-Klon-https://github.com/bureauworks/cli.git

Installieren von Abhängigkeiten

npm i

Machen Sie die CLI mit Ihrer Shell-Umgebung befreundet: 

$ chmod +x cli.js

Führen Sie die Konfiguration einmal aus - dies erstellt eine config.json-Datei in Ihrem Verzeichnis .bwx/.  

./cli.js-Konfiguration

Es sollte eine Meldung angezeigt werden, die die Dateierstellung bestätigt, die API jetzt mit der CLI testen!

Dienstleistungen ./cli.js

• ./cli.js Sprachen

Sie können den npm-Link verwenden, um uns zu ermöglichen, lokal 'einen Paketordner zu symlinken'. Wenn Sie dies tun, können Sie die CLI überall in Ihrem System mit der bwx-Kurzschrift aufrufen:

$ bwx-Zeitzonen

$ bwx-Sprachen

Verwenden Sie für die Hilfe:

$ bwx --help

Oder für bestimmte Befehle, z. B. den Projekterstellungsbefehl:

• bwx erstellen --help

 

Aktualisierung:

Wenn Sie unsere API-Befehlszeile bereits installiert haben, können Sie sie jederzeit auf die neueste Version aktualisieren.

Sobald Sie sich im Repository befinden, führen Sie die folgenden Befehle aus: 

• git ziehen https://github.com/bureauworks/cli.git

• npm-Link 

Auf diese Weise wird die CLI die neueste Version aus unserem Remote-Repository abrufen.

 

Befehle:

  • config - Liest Konfigurationsparameter aus der Befehlszeile und speichert in .bw/config.json
  • Sprachen - Listet die ISO-Codes der verfügbaren Sprachen auf
  • zeitzonen - Listet die in Bureau Works verfügbaren Zeitzonen auf
  • Dienstleistungen - Alle Dienste und IDs, die verfügbar sind, um Projekte in Bürowerken anzufordern

 

create [options] - Erstellt ein neues Projekt in Bureau Works, gibt eine JSON-Zeichenfolge mit IDs und relevanten Informationen zurück.

OPTIONEN:

  • -r, <--Referenzreferenz> 

Projektverweis, ein Zeichenfolgenwert, den Sie zum Identifizieren dieses Projekts verwenden können

 

  • -o, --Original <Original> 

  • Projekt-Quellsprache

 

  • -l, --Sprachen <Sprachen>

  • Projektzielsprachen, ISO-Codes durch Kommas getrennt

 

  • -s, <--Dienstleistungen>    

  "Long[] mit den Service-IDs, z.B. 1 für Übersetzung, 3 für die Transkription; getrennt mit Kommas



  • -n, <--Note> 

  • Eine beschreibende Note

 

  • -d, --Lieferung <longValue>   

  • Gewünschtes Lieferdatum

 

Beispiel: bwx create -r 'A reference code' -o en_us -l pt_br,es,ru_ru,de_de,fr_fr,it_it -s 1 -n 'Projektnotizen, spezielle Anweisungen, etc.' -d 1535661374000

 

upload [options] - Lädt eine Datei in ein Projekt hoch, das für die Produktion vorbereitet wird und in Bureau Works zitiert wird, gibt eine JSON mit den Projekt- und Job-ID-Informationen zurück.

OPTIONEN:

  • -p, <--projektProjektId>  

  • Die Projekt-ID

 

  • -s, --service_item <sid>   

  • Serviceartikel-ID

 

  • -f, <--Dateidatei>

  • Die Datei im aktuellen Dateisystem

 

Beispiel: -p 17530 -s 23207 -f ./files/filename.docx



kontinuierlich [Optionen] - Lädt eine Datei in ein kontinuierliches Integrationsprojekt hoch. Bei dieser Methode wird davon ausgegangen, dass In Ihrem Profil Standardzielsprachen eingerichtet sind. Kontinuierlich werden nach einem voreingestellten Zeitplan genehmigt.

OPTIONEN:

  • -t, <--tag-Tag-Tag>

  Ein Tag, um dieses Projekt zu identifizieren, z.B. ios, android, etc.

 

  • -r, <--Referenzreferenz>  

  • Eine mnemonic oder codierte Referenz für Ihren Datensatz

 

  • -f, <--Dateidatei>

  Die Datei im aktuellen Dateisystem





  • -l, --sprachen [Sprachen] 

  Optionale Projektzielsprachen, ISO-Codes durch Kommas getrennt - wenn festgelegt, überschreibt clientdefinierte voreingestellte Sprachen

 

  Beispiel: bwx continuous -r 'Einige Referenz' -t android -f ./files/strings.xml

 

  Erzwingen von Zielsprachen: -r 'Einige Referenz' -t android -f ./files/strings.xml -l pt_br,es_es,fr_fr,de_de

 

ready [options] - Kennzeichnet ein Projekt als BEREIT, was bedeutet, dass Sie die Upload-Dateien abgeschlossen haben und das System nun das Projekt zitiert. Gibt einen JSON mit der Kostenaufschlüsselung zurück.

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

Beispiel: é bwx ready -p 17532



genehmigen [Optionen] - Genehmigt ein Projekt in Büroarbeiten.

OPTIONEN:

  • -p, <--projektProjektId> 

  •Die Projekt-ID

 

  Beispiel: é bwx genehmigen -p 17532



Abbrechen [Optionen] - Bricht ein Projekt in Büroarbeiten ab

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  Beispiel: s bwx cancel -p 17532

 

Project [Options] - Lädt Projektmetadaten aus Bureau Works

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  Beispiel: 'bwx-Projekt -p 17532

 

Liste [Optionen] - Lädt eine Liste von Projekten aus Bureau Works unter Verwendung des Status als Parameter

OPTIONEN:

  • -s, <--Statusstatus>  

  "Der Projektstatus - PREPARING, PENDING, APPROVED, CANCELLED oder INVOICED

 

  Beispiel: 'bwx list -s PENDING

 

Kosten [Optionen] - Lädt die Kostenstruktur, die einem bestimmten Projekt zugeordnet ist

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  Beispiel: bwx kostet -p 17532

 

Items [Optionen] - Lädt die Elemente, die einem bestimmten Projekt zugeordnet sind

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  Beispiel: ' bwx items -p 17532



approve-job [Optionen] - Genehmigt einen bestimmten Auftrag

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  • -j, <--jobId>

  • Die Job-ID

 

  Beispiel: bwx approve-job -p 17532 -j 87432

 

reject-job [optionen] - Lehnt einen bestimmten Auftrag ab

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  • -j, <--jobId>

  • Die Job-ID

 

  Beispiel: s bwx reject-job -p 17532 -j 87432

 

Download [Optionen] - Lädt eine Datei mit einer Job-ID herunter

OPTIONEN:

  • -p, <--projektProjektId>  

  •Die Projekt-ID

 

  • -j, <--jobId>

  •Die Job-ID

  • -d, --Ziel [Verzeichnis]

  •Optional, wenn an die Funktion übergeben wird, speichert die Datei in dem gegebenen Verzeichnis

Beispiel: bwx herunterladen -p 17532 -j 87432 -d /files/repo/

 

download-continuous [options] - Lädt eine Datei mit einer Tag-Identifikation für Continuous Integration-Projekte herunter

OPTIONEN:

  • -t, <--tag-Tag-Tag>

  Ein Tag, der das Projekt im Pool von CI-Projekten identifiziert

  • -f, --dateiname <Dateiname>

  •Der Dateiname

  • -s, <--Statusstatus>

  Der Auftragsstatus, verwenden Sie DELIVERED für endgültige Dateien oder APPROVED für teilweise abgeschlossene Dateien mit Translation Memory- und Machine Translation Strings

  • -d, --Ziel [Verzeichnis]

  •Optional, wenn an die Funktion übergeben wird, speichert die Datei in dem gegebenen Verzeichnis

  Beispiel: bwx download-continuous -t android -f strings.xml -s APPROVED

 

download-by-filename [options] - Alternative Download-Methode, verwendet Project ID, Service Item ID und einen Dateinamen. Diese Methode ist nützlich für ungerade Lieferungen, z. B. wenn eine Übermittlungsdatei in mehrere Dateien aufgeteilt ist oder wenn die gelieferte Datei ein anderes Format als das der Eingabe hat.

OPTIONEN:

  • -p, <--projektProjektId>

  •Die Projekt-ID

 

  • -s, --service_item <sid>

  • Die Serviceartikel-ID

 

  • -f, --dateiname <Dateiname>

  Der Dateiname, einschließlich aller vorhergehenden Pfadkomponenten, z. B. /pt_br/filename.docx

 

  • -d, --Ziel [Verzeichnis]

  •Optional, wenn an die Funktion übergeben wird, speichert die Datei in dem gegebenen Verzeichnis

 

Beispiel: bwx download-by-filename -p 17532 -s 87432 -f pt_br/file.json -d /files/repo/

Verwandte Beiträge

Kommentare

0 Kommentare

Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.