Aller au contenu principal

Extraire les feuilles de travail de Excel

PDF4me Extraire les feuilles de travail est un REST point de terminaison qui extrait les feuilles sélectionnées d'un Excel classeur et les renvoie comme nouveau contenu de classeur. POST le fichier comme Base64 à office/ApiV2Excel/ExcelExtractWorksheetNommez les feuilles ou indiquez leurs index (à partir de 0), puis enregistrez le résultat décodé. Si vous n'envoyez aucun sélecteur, toutes les feuilles de calcul seront extraites.

Que fait ce point de terminaison ?

Permet de diviser un classeur par feuille. Vous envoyez le fichier complet une seule fois et indiquez les feuilles à inclure. extraire la feuille de calcul vers ExcelLa sélection peut se faire par nom d'onglet exact (sensible à la casse), par index (à partir de 0) ou par les deux simultanément (l'union est prise en compte). Cette fonction remplace la procédure manuelle de clic droit, Déplacer ou Copier pour la distribution de rapports, la répartition par équipe et tout flux de travail où les destinataires ne doivent voir que leur propre feuille.

Articles de blog connexes
Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.
En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.
Consultez le blog

Authentification de votre API Demande

Chaque PDF4me REST L'appel doit inclure votre API clé dans le Authorization En-tête : Authentification de base. Récupérez ou renouvelez votre clé depuis le tableau de bord développeur.

Point de terminaison

POSToffice/ApiV2Excel/ExcelExtractWorksheet

Informations importantes à ne pas manquer

Noms + index = union, ni l'un ni l'autre = tout
Fournir Noms des feuilles de travail, Index des feuilles de calcul, ou les deux ; toute feuille correspondant à l’une ou l’autre liste est extraite. Si vous omettez les deux, TOUTES les feuilles de calcul sont extraites, ce qui est rarement souhaitable pour une séparation ciblée.
Les index commencent à 0, les noms sont sensibles à la casse.
L'index 0 correspond au premier onglet. Un nom dont la casse diffère de celle de l'onglet réel ne correspond à aucun onglet ; par conséquent, l'absence inattendue d'une feuille dans le résultat est généralement due à une erreur de casse, et non à une autre erreur. API erreur.
Bureau API famille, forme de chemin différente
Excel Les opérations se déroulent sous office/ApiV2Excel/ sur le même hôte, pas sous /api/v2/Le corps est également imbriqué : un objet action (extraire la feuille de calcul vers Excel) au lieu de champs racines plats.

HTTP installation

Méthode: POST
URL: https://api.pdf4me.com/office/ApiV2Excel/ExcelExtractWorksheet
Type de contenu : application/json
Authorization: Basique <votre PDF4me API clé>

La réponse est : JSON: vérifiez le success drapeau, puis Base64-décoder le contenu du classeur renvoyé et l'enregistrer avec un .xlsx extension.

Quelles feuilles sont extraites : les noms ou les index ?

La sélection est déclarative. Vous n'avez jamais besoin de réorganiser ni de parcourir les feuilles ; vous décrivez les feuilles cibles une seule fois et le moteur les résout en fonction du classeur.

Noms vs indexVous envoyezCe qui est extrait
Noms seulement"worksheetNames": ["Sheet1", "Summary"]Feuilles dont le nom de l'onglet correspond exactement (sensible à la casse)
Index uniquement"worksheetIndexes": [0, 2]Feuilles à ces positions de base 0
Les deuxnoms + indexL'union : tout ce qui correspond à l'une ou l'autre des listes
Ni l'un ni l'autre{} objet d'actionChaque feuille de travail du cahier d'exercices

API champs corporels

ParamètreRequisTaperCe que cela faitExemple
documentRequiredobjectDocument reference carrying Name, the source Excel filename with its extension.{ "Name": "data.xlsx" }
docContentRequiredstringBase64-encoded bytes of the source workbook.UEsDBBQABgAIAAAA...
extractWorksheetToExcelActionRequiredobjectAction configuration object. Holds the worksheet selectors below; send it even when empty to extract all sheets.{ "worksheetNames": [...] }
worksheetNamesConditionalstring[]Inside the action object. Exact, case-sensitive sheet tab names to extract. Combine with indexes for a union.["Sheet1", "Summary"]
worksheetIndexesConditionalint[]Inside the action object. 0-based sheet positions to extract. Combine with names for a union.[0, 2]
cultureNameOptionalstringInside the action object. Culture code applied during processing.en-US

Exemples de charges utiles

Extraire deux feuilles par nom

{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"extractWorksheetToExcelAction": {
"worksheetNames": ["Sheet1", "Summary"]
}
}

Extraction par index à partir de 0

{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"extractWorksheetToExcelAction": {
"worksheetIndexes": [0, 2]
}
}

Conseils pour la collecte par le facteur

Headers
Content-Type: application/json + Authorization: Basic <apiKey>.
Body
raw JSON. Note the nesting: selectors go INSIDE extractWorksheetToExcelAction, not at the root.
Response
JSON with a success flag and Base64 workbook content. Decode the content before saving as .xlsx.
Sheet names
Copy tab names from Excel exactly. Case matters, and a non-matching name is skipped silently rather than raising an error.

Exemple curl

curl -X POST https://api.pdf4me.com/office/ApiV2Excel/ExcelExtractWorksheet \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-d '{
"document": { "Name": "data.xlsx" },
"docContent": "'"$(base64 -w 0 data.xlsx)"'",
"extractWorksheetToExcelAction": {
"worksheetNames": ["Summary"]
}
}' \
--output response.json

Que signifie le API retour?

UN JSON résultat décrivant l'extraction et le transport du nouveau contenu du classeur comme Base64.

ChampTaperCe qu'il contient
document / documentsString (Base64) / ArrayThe extracted workbook content. A single extraction returns one document; multi-sheet extraction can return an array, so handle both shapes.
fileNameStringOutput filename for the extracted workbook.
successBooleantrue when extraction succeeded. Check this before decoding content.
errorMessageStringPopulated when success is false; explains what went wrong.

Exemples de code

Excel Les terminaux de bureau ne sont pas encore couverts par per-language dossiers d'exemples ; le dépôt d'exemples contient le modèle de requête utilisé par chaque PDF4me famille de points de terminaison :

FAQ

How do I extract a single sheet from an Excel workbook?+
Send the workbook as Base64 in docContent and put the sheet name in extractWorksheetToExcelAction.worksheetNames, for example ["Summary"]. The API returns a new workbook containing only that sheet.
What happens if I provide both worksheetNames and worksheetIndexes?+
The selections combine as a union: any sheet matching either a listed name or a listed index is extracted. If you provide neither field, every worksheet in the workbook is extracted.
Are worksheet indexes 0-based or 1-based?+
0-based. Index 0 is the first worksheet, index 1 the second, and so on. This matches the PDF4me Extract Worksheets documentation across platforms.
Are worksheet names case-sensitive?+
Yes. The name must match the sheet tab exactly, including case. A name that does not match any sheet is simply not extracted, so an unexpectedly missing sheet usually means a case mismatch rather than an API error.
Why is this endpoint not under /api/v2/?+
Excel operations belong to the PDF4me office API family, addressed as office/ApiV2Excel/ plus the action name on the same api.pdf4me.com host, with the same Basic Authorization header.
Does extraction change the source workbook?+
No. The source file you send is only read. The extracted sheets are returned as new workbook content in the response; nothing is written back to your original.
Can I extract every sheet into its own file?+
Sending an empty action object extracts all worksheets. For strict one-file-per-sheet splits, iterate your sheet list and call the endpoint once per name; each call returns a workbook containing just that sheet.

Pourquoi extraire des feuilles de calcul via API au lieu de manuellement ?

La voie manuelle est Déplacer ou copier des feuilles de travail dans Excel: cliquez avec le bouton droit sur l'onglet, Déplacer ou Copier, cochez Créer une copie, enregistrez comme nouveau fichier, répétez l'opération pour chaque feuille, chaque classeur, chaque cycle de reporting. API Cette boucle est remplacée par une requête déterministe par fractionnement, ce qui est idéal lorsque le classeur arrive à intervalles réguliers et que le fractionnement alimente d'autres systèmes. La sortie reste standard. Office Open XML cahier d'exercices qui ExcelLibreOffice et Google Sheets sont tous ouverts.

Actions connexes

Même tâche sur d'autres plateformes

Obtenez de l'aide