Pular para o conteúdo principal

Extrair planilhas de Excel

PDF4me Extrair Planilhas é um REST ponto final que extrai planilhas selecionadas de um Excel e os retorna como novo conteúdo da planilha. POST o arquivo como Base64 para office/ApiV2Excel/ExcelExtractWorksheet, nomeie as planilhas ou liste seus índices baseados em 0 e salve o resultado decodificado. Não envie nenhum seletor e todas as planilhas serão extraídas.

O que este endpoint faz

Divide uma planilha em folhas. Você envia o arquivo inteiro uma única vez e descreve quais folhas deseja incluir. ação de extrairplanilhaparaExcelA opção pode ser selecionada pelo nome exato da guia (respeitando maiúsculas e minúsculas), por índice baseado em zero ou por ambos simultaneamente (a união é considerada). Ela substitui a rotina manual de clicar com o botão direito do mouse e selecionar "Mover" ou "Copiar" para distribuição de relatórios, divisões por equipe e qualquer fluxo de trabalho em que os destinatários devam visualizar apenas a própria planilha.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue

Autenticando seu API Solicitar

Todo PDF4me REST A chamada deve incluir o seu API chave no Authorization Defina o cabeçalho como autenticação básica. Obtenha ou altere sua chave no painel do desenvolvedor.

Ponto final

POSToffice/ApiV2Excel/ExcelExtractWorksheet

Fatos importantes que você não deve perder

Nomes + índices = união, nenhum dos dois = tudo
Fornecer Nomes das planilhas, Índices da planilha, ou ambos; qualquer planilha que corresponda a qualquer uma das listas será extraída. Omita ambas e TODAS as planilhas serão extraídas, o que raramente é o desejado para uma divisão direcionada.
Os índices começam em 0 e os nomes diferenciam maiúsculas de minúsculas.
O índice 0 corresponde à primeira aba da planilha. Um nome que difere em maiúsculas e minúsculas da aba real não corresponde a nada, portanto, uma planilha inesperadamente ausente na saída geralmente significa uma incompatibilidade de maiúsculas e minúsculas, e não um erro. API erro.
Escritório API família, formato de caminho diferente
Excel operações vivem sob escritório/ApiV2Excel/ no mesmo host, não sob /api/v2/O corpo também está aninhado: um objeto de ação (ação de extrairplanilhaparaExcel) em vez de campos raiz planos.

HTTP configurar

Método: POST
URL: https://api.pdf4me.com/office/ApiV2Excel/ExcelExtractWorksheet
Tipo de conteúdo: aplicativo/json
Authorization: Básico <seu PDF4me API chave>

A resposta é JSON: verifique o success bandeira, então Base64-decodificar o conteúdo da planilha retornada e salvá-lo com um .xlsx extensão.

Quais planilhas são extraídas: nomes ou índices?

A seleção é declarativa. Você nunca reordena ou repete o processo; você descreve as planilhas de destino uma única vez e o mecanismo as resolve em relação à pasta de trabalho.

Nomes versus índicesVocê enviaO que é extraído?
Apenas nomes"worksheetNames": ["Sheet1", "Summary"]Planilhas cujo nome da guia corresponde exatamente (diferencia maiúsculas de minúsculas)
Apenas índices"worksheetIndexes": [0, 2]Folhas nessas posições de base 0
Ambosnomes + índicesA união: qualquer coisa que corresponda a qualquer uma das listas.
Nenhum{} objeto de açãoTodas as folhas de exercícios do livro de atividades

API campos corporais

ParâmetroObrigatórioTipoO que fazExemplo
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

Exemplos de cargas úteis

Extraia duas folhas pelo nome.

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

Extrair por índice baseado em 0

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

Dicas de coleta do carteiro

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.

exemplo de 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

O que significa o API retornar?

A JSON resultado que descreve a extração e o transporte do novo conteúdo da planilha como Base64.

CampoTipoO que contém
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.

Exemplos de código

Excel Os endpoints de escritório ainda não são cobertos por per-language pastas de exemplo; o repositório de exemplos contém o padrão de requisição usado por todos. PDF4me família de endpoints:

Perguntas frequentes

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.

Por que extrair planilhas via API em vez de manualmente?

O percurso manual é Mova ou copie planilhas em ExcelClique com o botão direito do mouse na guia, selecione Mover ou Copiar, marque Criar uma cópia, salve como um novo arquivo e repita o processo para cada planilha, pasta de trabalho e ciclo de relatório. API Substitui esse loop por uma solicitação determinística por divisão, que é o ideal quando a planilha chega de acordo com um cronograma e a divisão alimenta outros sistemas. A saída permanece padrão. Escritório aberto XML caderno de exercícios que ExcelO LibreOffice e o Google Sheets estão todos abertos.

Ações relacionadas

A mesma tarefa em outras plataformas.

Obtenha ajuda