Marque blanche

La marque blanche vous permet d'habiller Coffrify à vos couleurs : nom de société, logo, couleur principale, thème et pieds de page apparaissent sur les pages de partage que vos destinataires consultent au moment de télécharger un fichier. Tout se pilote via deux points d'accès, GET /v1/branding pour lire la configuration et PATCH /v1/branding pour la modifier, plus POST /v1/branding/upload-logo pour téléverser votre logo. Ces trois appels exigent une clé dont le périmètre inclut le scope branding:manage.

Lire la configuration actuelle

Commencez par récupérer l'état courant de votre marque blanche. La réponse renvoie un objet branding contenant les champs configurables, ou null si vous n'avez encore rien personnalisé.

import { Coffrify } from '@coffrify/sdk';
 
const coffrify = new Coffrify({ apiKey: process.env.COFFRIFY_API_KEY });
 
const { branding } = await coffrify.branding.get();
console.log(branding);

{
  "branding": {
    "company_name": "Acme Studio",
    "logo_url": "https://cdn.coffrify.com/branding/ws_123/1717920000.png",
    "primary_color": "#007AFF",
    "accent": "#34C759",
    "theme": "light",
    "custom_footer": "© Acme Studio 2026",
    "hide_powered_by": false,
    "support_email": "support@acme.example",
    "white_label_mode": false,
    "subdomain_slug": "acme"
  }
}

Les champs personnalisables

Le PATCH accepte uniquement les champs ci-dessous. Tout champ inconnu est ignoré, et un corps qui ne contient aucun champ valide renvoie une erreur 400 de code validation_error. La couleur principale vaut #007AFF par défaut tant que vous ne la changez pas.

Modifier vos couleurs et votre pied de page

Envoyez en PATCH uniquement les champs que vous souhaitez changer. La réponse renvoie l'objet branding mis à jour. Comme il s'agit d'une écriture, ajoutez un en-tête Idempotency-Key pour pouvoir rejouer l'appel sans risque en cas de coupure réseau.

import { Coffrify } from '@coffrify/sdk';
 
const coffrify = new Coffrify({ apiKey: process.env.COFFRIFY_API_KEY });
 
const { branding } = await coffrify.branding.update({
  company_name: 'Acme Studio',
  primary_color: '#1E40AF',
  accent: '#F59E0B',
  theme: 'light',
  custom_footer: '© Acme Studio 2026',
  hide_powered_by: true,
  white_label_mode: true,
});
 
console.log(branding.primary_color);

Téléverser votre logo

Le logo se téléverse en multipart/form-data via un unique champ file. Les formats acceptés sont PNG, JPEG, SVG, WebP et GIF, dans la limite de 2 Mo. La réponse renvoie un champ logo_url que vous reportez ensuite sur le champ logo_url via un PATCH /v1/branding.

// Téléversement direct en REST (multipart/form-data)
const form = new FormData();
form.append('file', fileBlob, 'logo.png');
 
const res = await fetch('https://api.coffrify.com/v1/branding/upload-logo', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.COFFRIFY_API_KEY}` },
  body: form,
});
const { logo_url } = await res.json();
 
// On reporte ensuite l'URL sur la marque blanche
import { Coffrify } from '@coffrify/sdk';
const coffrify = new Coffrify({ apiKey: process.env.COFFRIFY_API_KEY });
await coffrify.branding.update({ logo_url });

Le résultat côté destinataire

Une fois white_label_mode activé, vos destinataires voient la page de partage à vos couleurs : votre logo, votre couleur principale, votre pied de page et, si hide_powered_by est à true, sans la mention Coffrify. Le sous-domaine {slug}.coffrify.com que vous définissez via subdomain_slug pointe vers votre hub de partage personnalisé. Vous offrez ainsi une expérience cohérente avec votre propre marque, de l'envoi jusqu'au téléchargement.