Upload bestanden via de API met een vooraf ondertekende URL en koppel ze daarna aan Whop-resources.
Upload bestanden naar Whop voor gebruik in cursussen, forums, profielen, geschillen en meer.
Hoe uploads werken
Uploaden is een flow in twee stappen, en de SDK helpt bij de eerste stap:
Maak een bestandsrecord aan.files.create geeft het id van het nieuwe bestand terug, plus een vooraf ondertekende upload_url en de upload_headers die je erbij moet meesturen.
Verstuur de bytes zelf. Stuur de inhoud van het bestand met PUT naar upload_url, met die headers. De SDK draagt de bytes niet voor je over.
Zodra de bytes zijn aangekomen, wordt het bestand verwerkt en wordt de upload_statusready. Gebruik files.retrieve om te pollen totdat de status ready is, koppel het id daarna aan een resource en lees de definitieve url uit.Zie Bestanden rechtstreeks uploaden om rechtstreeks vanuit de browser te uploaden zodat de bytes nooit je server raken, of om een groot bestand in delen te versturen.
De SDK initialiseren
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");
Een bestand uploaden
Maak het record aan en stuur de bytes daarna met PUT naar de vooraf ondertekende URL die wordt teruggegeven.
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
Openbare en privébestanden
Elk bestand dat je uploadt, heeft een zichtbaarheid die de toegang bepaalt. Je kiest de zichtbaarheid bij het uploaden en kunt deze later niet meer wijzigen.
Zichtbaarheid
URL-type
Wie heeft toegang
Te gebruiken voor
private (standaard)
Ondertekende URL die verloopt
Alleen je app, via de API
Bijlagen bij berichten, door gebruikers geüploade documenten, gevoelige inhoud, door AI gegenereerde bestanden
public
Permanente, niet-ondertekende URL van het content delivery network
Stel de zichtbaarheid in vóór het uploaden. Openbare bestanden worden gecachet op het CDN van Whop en zijn toegankelijk voor iedereen met de URL — er is geen manier om de toegang in te trekken. Als de inhoud gebruikersspecifiek of gevoelig is, houd dan de standaardwaarde private aan.
Een openbaar bestand uploaden
Geef de zichtbaarheid public door bij het aanmaken van het bestand en upload de bytes daarna op dezelfde manier:
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
Als je een bestand aan een resource koppelt, wordt het verplaatst naar de opslag die past bij de zichtbaarheid van die resource. Een expliciete visibility is vooral van belang voor bestanden waarnaar je rechtstreeks linkt zonder ze te koppelen.
Bevestigen dat de upload is voltooid
Nadat de bytes zijn aangekomen, wordt het bestand asynchroon verwerkt. Haal het op totdat upload_status niet meer pending of processing is. Lees bij ready de definitieve url uit. Stop bij failed en toon de fout.
Mediatype (bijv. image/jpeg), afgeleid van de extensie van de bestandsnaam
size
Bestandsgrootte in bytes. null totdat de upload is voltooid
url
Waar je het bestand kunt downloaden: een permanente URL van het content delivery network wanneer het openbaar is, een ondertekende, verlopende URL wanneer het privé is. null totdat de upload is voltooid
upload_status
Status: pending, processing, ready of failed
visibility
public of private
upload_url
Een vooraf ondertekende URL waarnaar je de bytes met PUT verstuurt. Alleen aanwezig in het antwoord van create
upload_headers
Headers die je meestuurt met de upload-PUT. Alleen aanwezig in het antwoord van create
Assistant
Responses are generated using AI and may contain mistakes.