Upload filer via API’et med en forhåndssigneret URL, og knyt dem derefter til Whop-ressourcer.
Upload filer til Whop til brug i kurser, fora, profiler, tvister og meget mere.
Sådan fungerer uploads
Upload er et flow i to trin, og SDK’et hjælper med det første trin:
Opret en filpost.files.create returnerer den nye fils id samt en forhåndssigneret upload_url og de upload_headers, der skal sendes med den.
Send selv bytes. Lav en PUT af filens indhold til upload_url med disse headers. SDK’et overfører ikke bytes for dig.
Når bytes er modtaget, behandles filen, og dens upload_status bliver ready. Brug files.retrieve til at polle, indtil den er ready, og knyt derefter id til en ressource, og læs den endelige url.Se Upload filer direkte for at uploade direkte fra browseren, så bytes aldrig rører din server, eller for at sende en stor fil i dele.
Initialiser SDK’et
import { WhopClient } from "@whop/sdk";const client = new WhopClient({ token: process.env.WHOP_API_KEY,});
use whop_sdk::prelude::*;let config = ClientConfig { token: Some(std::env::var("WHOP_API_KEY").expect("WHOP_API_KEY is not set")), ..Default::default()};let client = Whop::new(config).expect("Failed to build client");
Upload en fil
Opret posten, og lav derefter en PUT af bytes til den forhåndssignerede URL, der returneres.
import { readFile } from "node:fs/promises";// 1. Create the file record and get a presigned upload URLconst file = await client.files.create({ filename: "photo.jpg" });// 2. Send the bytes to storage yourselfconst bytes = await readFile("./photo.jpg");await fetch(file.upload_url!, { method: "PUT", headers: file.upload_headers as Record<string, string>, body: bytes,});console.log(file.id); // file_xxxxxxxxxxxxx — attach it once it's ready
import requests# 1. Create the file record and get a presigned upload URLfile = client.files.create(filename="photo.jpg")# 2. Send the bytes to storage yourselfwith open("./photo.jpg", "rb") as contents: requests.put( file.upload_url, headers=file.upload_headers or {}, data=contents, )print(file.id) # file_xxxxxxxxxxxxx — attach it once it's ready
require "net/http"# 1. Create the file record and get a presigned upload URLfile = client.files.create(filename: "photo.jpg")# 2. Send the bytes to storage yourselfuri = URI(file.upload_url)request = Net::HTTP::Put.new(uri)(file.upload_headers || {}).each { |key, value| request[key] = value }request.body = File.binread("./photo.jpg")Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }puts file.id # file_xxxxxxxxxxxxx — attach it once it's ready
import ( "bytes" "fmt" "net/http" "os")// 1. Create the file record and get a presigned upload URLfile, err := client.Files.Create(context.TODO(), &whopsdk.CreateFilesRequest{ Filename: "photo.jpg",})if err != nil { return err}// 2. Send the bytes to storage yourselfdata, err := os.ReadFile("./photo.jpg")if err != nil { return err}request, err := http.NewRequest(http.MethodPut, *file.UploadURL, bytes.NewReader(data))if err != nil { return err}for key, value := range file.UploadHeaders { request.Header.Set(key, fmt.Sprint(value))}if _, err := http.DefaultClient.Do(request); err != nil { return err}fmt.Println(file.ID) // file_xxxxxxxxxxxxx — attach it once it's ready
// 1. Create the file record and get a presigned upload URLlet file = client .files .create( &CreateFilesRequest { filename: "photo.jpg".to_string(), ..Default::default() }, None, ) .await?;// 2. Send the bytes to storage yourselflet contents = std::fs::read("./photo.jpg")?;let mut request = reqwest::Client::new() .put(file.upload_url.as_deref().unwrap()) .body(contents);if let Some(headers) = &file.upload_headers { for (key, value) in headers { if let Some(value) = value.as_str() { request = request.header(key, value); } }}request.send().await?;println!("{}", file.id); // file_xxxxxxxxxxxxx — attach it once it's ready
Offentlige og private filer
Hver fil, du uploader, har en synlighed, der styrer adgangen. Du vælger synlighed ved upload og kan ikke ændre den senere.
Synlighed
URL-type
Hvem har adgang
Bruges til
private (standard)
Signeret URL, der udløber
Kun din app via API’et
Vedhæftninger til beskeder, dokumenter uploadet af brugere, følsomt indhold, AI-genererede filer
Angiv synligheden før upload. Offentlige filer caches på Whops CDN og er tilgængelige for alle med URL’en — der er ingen måde at tilbagekalde adgangen på. Hvis indholdet er brugerspecifikt eller følsomt, så behold standarden private.
Upload af en offentlig fil
Angiv synligheden public, når du opretter filen, og upload derefter bytes på samme måde:
const file = await client.files.create({ filename: "product-cover.jpg", visibility: "public",});// PUT the bytes to file.upload_url, then file.url is a permanent CDN URL
file = client.files.create( filename="product-cover.jpg", visibility="public",)# PUT the bytes to file.upload_url, then file.url is a permanent CDN URL
file = client.files.create( filename: "product-cover.jpg", visibility: "public",)# PUT the bytes to file.upload_url, then file.url is a permanent CDN URL
file, err := client.Files.Create(context.TODO(), &whopsdk.CreateFilesRequest{ Filename: "product-cover.jpg", Visibility: whopsdk.CreateFilesRequestVisibilityPublic.Ptr(),})// PUT the bytes to file.UploadURL, then file.URL is a permanent CDN URL
let file = client .files .create( &CreateFilesRequest { filename: "product-cover.jpg".to_string(), visibility: Some(CreateFilesRequestVisibility::Public), ..Default::default() }, None, ) .await?;// PUT the bytes to file.upload_url, then file.url is a permanent CDN URL
Når du knytter en fil til en ressource, flyttes den til det lager, der matcher ressourcens egen synlighed. En eksplicit visibility har primært betydning for filer, du linker direkte til uden at knytte dem til noget.
Bekræft, at uploaden er færdig
Når bytes er modtaget, behandles filen asynkront. Hent den, indtil upload_status ikke længere er pending eller processing. Når den er ready, skal du læse den endelige url. Når den er failed, skal du stoppe og vise fejlen.
Medietype (f.eks. image/jpeg), udledt af filnavnets endelse
size
Filstørrelse i bytes. null, indtil uploaden er færdig
url
Hvor filen kan downloades: en permanent content delivery network-URL, når den er offentlig, og en signeret, udløbende URL, når den er privat. null, indtil uploaden er færdig
upload_status
Status: pending, processing, ready eller failed
visibility
public eller private
upload_url
En forhåndssigneret URL, som bytes skal sendes til med PUT. Findes kun i create-svaret
upload_headers
Headers, der skal sendes med upload-PUT’en. Findes kun i create-svaret
Assistant
Responses are generated using AI and may contain mistakes.