Generate preview package synchronously
curl --request POST \
--url https://eu.phrase.com/connectors/document360/v1/sync/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
}
}
'import requests
url = "https://eu.phrase.com/connectors/document360/v1/sync/preview"
payload = {
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credentials: {
connectionUid: '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
organizationUid: '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
},
path: {
pathType: 'ARTICLE',
projectId: '8f1c0f7a-1111-4a2b-9c3d-000000000001',
articleId: '8f1c0f7a-4444-4a2b-9c3d-000000000004'
}
})
};
fetch('https://eu.phrase.com/connectors/document360/v1/sync/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.phrase.com/connectors/document360/v1/sync/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
'connectionUid' => '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
'organizationUid' => '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
],
'path' => [
'pathType' => 'ARTICLE',
'projectId' => '8f1c0f7a-1111-4a2b-9c3d-000000000001',
'articleId' => '8f1c0f7a-4444-4a2b-9c3d-000000000004'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu.phrase.com/connectors/document360/v1/sync/preview"
payload := strings.NewReader("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/document360/v1/sync/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/connectors/document360/v1/sync/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n }\n}"
response = http.request(request)
puts response.read_body""""Document360
Generate preview package synchronously
Generate the preview package of one Document360 article. The connector reads the article’s
rendered HTML and stores it as a zip package (index.html in the root, referenced images
under assets/) in Phrase file storage. path must be an ARTICLE path (use list-files
to discover ids).
The preview shows the article as it currently is (drafts included) in the project’s default language, without the Document360 site styling.
Choosing sync vs async
/sync/previewblocks until the connector finishes. Subject to gateway timeouts (~60 s)./async/previewreturns immediately with arequestIdand posts the result to the URL inX-Webhookwhen ready.
Response shape (sync only) is controlled by X-ResponseType:
ID(default) — JSON{ "storageId": "..." }. The caller downloads the zip package from Phrase file storage.OBJECT— the zip package itself asapplication/zip.
No preview available. When the article has no HTML, the call still succeeds (HTTP 200)
with the JSON body { "available": false, "message": "..." }, whatever X-ResponseType is.
For the async variant the same body is POSTed to the webhook.
POST
/
document360
/
v1
/
sync
/
preview
Generate preview package synchronously
curl --request POST \
--url https://eu.phrase.com/connectors/document360/v1/sync/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
}
}
'import requests
url = "https://eu.phrase.com/connectors/document360/v1/sync/preview"
payload = {
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credentials: {
connectionUid: '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
organizationUid: '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
},
path: {
pathType: 'ARTICLE',
projectId: '8f1c0f7a-1111-4a2b-9c3d-000000000001',
articleId: '8f1c0f7a-4444-4a2b-9c3d-000000000004'
}
})
};
fetch('https://eu.phrase.com/connectors/document360/v1/sync/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.phrase.com/connectors/document360/v1/sync/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
'connectionUid' => '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
'organizationUid' => '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
],
'path' => [
'pathType' => 'ARTICLE',
'projectId' => '8f1c0f7a-1111-4a2b-9c3d-000000000001',
'articleId' => '8f1c0f7a-4444-4a2b-9c3d-000000000004'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu.phrase.com/connectors/document360/v1/sync/preview"
payload := strings.NewReader("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/document360/v1/sync/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/connectors/document360/v1/sync/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n }\n}"
response = http.request(request)
puts response.read_body""""Authorizations
IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer
Headers
A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.
Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default. (ID => JSON with storageId of the zip package, OBJECT => the zip package as binary stream).
Available options:
ID, OBJECT Body
application/json
Request body for generating the preview package of one Document360 article. The preview shows the article in the project's default language; there is no locale.
Connection holding the Document360 API key and host.
Show child attributes
Show child attributes
The article to preview (ARTICLE with projectId and articleId). Any other path type is rejected with 400.
Show child attributes
Show child attributes
Document360 settings; may be omitted (connector defaults apply).
Show child attributes
Show child attributes
Example:
{
"includeArchived": false,
"workspaceTypes": ["KNOWLEDGE_BASE"],
"publishAfterUpload": true
}
Response
OK — the preview package (zip) as a binary stream (returned when X-ResponseType=OBJECT).
The response is of type file.
Was this page helpful?