Complete a Fluid OS widget package upload

POST

api

company

fluid_os

widget_package_versions

{version}

complete_upload

Complete a Fluid OS widget package upload

curl --request POST \
  --url https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_key": "<string>",
  "artifacts": [
    {
      "path": "widget.js",
      "contentType": "application/javascript",
      "content_type": "application/javascript",
      "sha256": "<string>",
      "checksum": "<string>",
      "bytes": 1,
      "size": 1
    }
  ]
}
'

import requests

url = "https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload"

payload = {
    "package_key": "<string>",
    "artifacts": [
        {
            "path": "widget.js",
            "contentType": "application/javascript",
            "content_type": "application/javascript",
            "sha256": "<string>",
            "checksum": "<string>",
            "bytes": 1,
            "size": 1
        }
    ]
}
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({
    package_key: '<string>',
    artifacts: [
      {
        path: 'widget.js',
        contentType: 'application/javascript',
        content_type: 'application/javascript',
        sha256: '<string>',
        checksum: '<string>',
        bytes: 1,
        size: 1
      }
    ]
  })
};

fetch('https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload', 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://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload",
  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([
    'package_key' => '<string>',
    'artifacts' => [
        [
                'path' => 'widget.js',
                'contentType' => 'application/javascript',
                'content_type' => 'application/javascript',
                'sha256' => '<string>',
                'checksum' => '<string>',
                'bytes' => 1,
                'size' => 1
        ]
    ]
  ]),
  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://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload"

	payload := strings.NewReader("{\n  \"package_key\": \"<string>\",\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"content_type\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"checksum\": \"<string>\",\n      \"bytes\": 1,\n      \"size\": 1\n    }\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://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_key\": \"<string>\",\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"content_type\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"checksum\": \"<string>\",\n      \"bytes\": 1,\n      \"size\": 1\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload")

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  \"package_key\": \"<string>\",\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"content_type\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"checksum\": \"<string>\",\n      \"bytes\": 1,\n      \"size\": 1\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "packageId": "<string>",
  "version": "<string>",
  "scriptUrl": "<string>",
  "cssUrls": [
    "<string>"
  ],
  "manifestUrl": "<string>"
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "error_message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Path Parameters

version

string

required

Non-empty, object-path-safe widget package version identifier to verify. Dotted versions such as 1.0.0 are accepted; only exact . or .. path segments and characters outside [A-Za-z0-9._~-] are rejected.

Minimum string length: 1

Pattern: ^(?!\.\.?$)[A-Za-z0-9._~-]+$

Body

application/json

Request payload

package_key

string | null

Optional non-empty, object-path-safe widget package key. When omitted, the company's widget package is used; . and .. are not accepted.

Minimum string length: 1

Pattern: ^(?!\.\.?$)[A-Za-z0-9._~-]+$

artifacts

(Widget script artifact · object | Widget manifest artifact · object | Stylesheet artifact · object | Source map artifact · object)[]

Optional artifact metadata to compare with the stored upload session. When supplied, the list must include exactly the stored upload-session artifact paths; omissions and extras are rejected.

Minimum array length: 1

Optional artifact metadata supplied when completing a widget package upload. Artifact paths must be unique top-level package artifact filenames within the request; accepted names are widget.js, manifest.json, *.css, and *.js.map with no slash paths. Accepted content types are application/javascript for widget.js, application/json for manifest.json and *.js.map, and text/css for *.css. Byte sizes are non-negative and checked against configured per-artifact and bundle limits; defaults are 5 MiB per artifact and 10 MiB per bundle unless environment config changes them. sha256/checksum, bytes/size, and contentType/content_type are accepted aliases and must match when both aliases are present; supplied artifact metadata is compared with the stored upload-session/package version artifact metadata during verification. If artifacts are supplied, they must include exactly the stored upload-session artifact paths. Manifest verification is separate and happens against uploaded artifact content.

Widget script artifact
Widget manifest artifact
Stylesheet artifact
Source map artifact

Show child attributes

Response

Success

Approved Fluid OS widget package version details.

status

string

required

packageId

string

required

version

string

required

Non-empty, object-path-safe widget package version identifier. Dotted versions such as 1.0.0 are accepted; only exact . or .. path segments and characters outside [A-Za-z0-9._~-] are rejected.

Minimum string length: 1

Pattern: ^(?!\.\.?$)[A-Za-z0-9._~-]+$

scriptUrl

string<uri>

required

cssUrls

string<uri>[]

required

manifestUrl

string<uri>

required

Complete a Fluid OS widget package upload

curl --request POST \
  --url https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_key": "<string>",
  "artifacts": [
    {
      "path": "widget.js",
      "contentType": "application/javascript",
      "content_type": "application/javascript",
      "sha256": "<string>",
      "checksum": "<string>",
      "bytes": 1,
      "size": 1
    }
  ]
}
'

import requests

url = "https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload"

payload = {
    "package_key": "<string>",
    "artifacts": [
        {
            "path": "widget.js",
            "contentType": "application/javascript",
            "content_type": "application/javascript",
            "sha256": "<string>",
            "checksum": "<string>",
            "bytes": 1,
            "size": 1
        }
    ]
}
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({
    package_key: '<string>',
    artifacts: [
      {
        path: 'widget.js',
        contentType: 'application/javascript',
        content_type: 'application/javascript',
        sha256: '<string>',
        checksum: '<string>',
        bytes: 1,
        size: 1
      }
    ]
  })
};

fetch('https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload', 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://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload",
  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([
    'package_key' => '<string>',
    'artifacts' => [
        [
                'path' => 'widget.js',
                'contentType' => 'application/javascript',
                'content_type' => 'application/javascript',
                'sha256' => '<string>',
                'checksum' => '<string>',
                'bytes' => 1,
                'size' => 1
        ]
    ]
  ]),
  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://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload"

	payload := strings.NewReader("{\n  \"package_key\": \"<string>\",\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"content_type\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"checksum\": \"<string>\",\n      \"bytes\": 1,\n      \"size\": 1\n    }\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://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_key\": \"<string>\",\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"content_type\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"checksum\": \"<string>\",\n      \"bytes\": 1,\n      \"size\": 1\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/fluid_os/widget_package_versions/{version}/complete_upload")

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  \"package_key\": \"<string>\",\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"content_type\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"checksum\": \"<string>\",\n      \"bytes\": 1,\n      \"size\": 1\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "<string>",
  "packageId": "<string>",
  "version": "<string>",
  "scriptUrl": "<string>",
  "cssUrls": [
    "<string>"
  ],
  "manifestUrl": "<string>"
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "error_message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Storefront

Commerce

Checkout

Members

Messaging

People

Payments

DAM

Website

Portal

Content and tools

Analytics

Sales channels

Settings

FairShare SDK

Droplets

Developers

Portal & Widgets

Complete a Fluid OS widget package upload

Authorizations

Path Parameters

Body

Response