Pular para o conteúdo principal

Extrair linhas de Excel

PDF4me Extrair linhas é um REST ponto final que lê linhas da planilha de um Excel planilha e os retorna como estruturados JSON. POST o arquivo .xlsx como Base64 para office/ApiV2Excel/ExcelExtractRows, defina o escopo da planilha e do intervalo de linhas no objeto de ação e consuma o rowData array. Retorna dados, não um arquivo: document retorna nulo.

O que este endpoint faz

Transforma uma fatia de planilha em uma JSON matriz: cada linha se torna um objeto em dados_dados, pronto para uma inserção no banco de dados, um API chamada ou relatório. É a contraparte somente leitura de Adicionar Linhas e Atualizar Linhas, e do API-lado equivalente de exportar Excel dados sem abrir ExcelNenhum arquivo modificado foi gerado.

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

POSTescritório/ApiV2Excel/ExcelExtrairLinhas

Fatos importantes que você não deve perder

rowData é a saída, os campos do arquivo são nulos.
Este endpoint retorna dados, não uma planilha modificada. documento e fileName retornar nulo por design; código que espera um Base64 O arquivo ali vai corromper.
O mecanismo conta as linhas a partir de 0.
A linha 0 é Excel linha 1, e -1 significa a última linha de dados, a mesma semântica. n8n Documentos de ação "Extrair linhas" para este mecanismo. Intervalos com diferença de uma unidade são a principal dúvida de suporte.
Somente leitura: seu caderno de exercícios permanece intacto.
A extração analisa o arquivo e serializa as linhas para JSONComo nada é gravado de volta, é seguro executar o comando em planilhas e arquivos de produção.

HTTP configurar

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

A resposta é JSON: verifique o success flag, depois itere o dados_dados matriz. Não há arquivo para decodificar.

Em que a função Extrair Linhas se diferencia das outras? Excel Ações da linha?

A família de linhas abrange as operações de escrever, sobrescrever e ler. Selecione de acordo com o que deve acontecer com a planilha.

Ação versus comportamentoO que isso faz com o caderno de exercíciosO que você recebe de volta
Extrair linhas (este endpoint)Nada, somente leituraA rowData JSON matriz, um objeto por linha
Adicionar linhasAcrescenta ou insere novas linhas.A planilha modificada como Base64
Atualizar linhasSobrescreve os valores nas linhas existentes.A planilha modificada como Base64
Excluir linhasRemove linhasA planilha modificada como Base64

API campos corporais

ParâmetroObrigatórioTipoO que fazExemplo
documentRequiredobjectDocument reference carrying Name, the Excel filename with its extension.{ "Name": "data.xlsx" }
docContentRequiredstringBase64-encoded bytes of the workbook to read.UEsDBBQABgAIAAAA...
extractRowsToExcelActionRequiredobjectAction configuration object. An empty object is valid and reads the default worksheet.{}
worksheetNameOptionalstringInside the action object. Target worksheet by name. Names are matched exactly, so a typo silently misses the sheet.Sheet1
worksheetIndexOptionalnumberInside the action object. Target worksheet by position. The extraction engine counts 0-based, so 0 is the first sheet.0
fromRow / toRowOptionalnumberInside the action object. Row range to extract. The engine counts rows 0-based with -1 meaning to the last data row, per the shared engine documented on the n8n Extract Rows action.0, -1
cultureNameOptionalstringInside the action object. Culture used when serializing dates and numbers, for example en-US or de-DE.en-US

Exemplos de cargas úteis

Leia a planilha padrão

{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"extractRowsToExcelAction": {}
}

Leia uma folha de exercícios com o nome da instituição e valores que levem em consideração a cultura.

{
"document": { "Name": "sales.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"extractRowsToExcelAction": {
"worksheetName": "Q3",
"cultureName": "en-US"
}
}

Dicas de coleta do carteiro

Headers
Content-Type: application/json + Authorization: Basic <apiKey>.
Body
raw JSON. extractRowsToExcelAction may be an empty object {}; worksheet targeting and ranges are optional narrowing.
Response
Plain JSON. Assert on rowData, not on document: the file fields are null for this endpoint by design.
Ranges
The engine counts rows 0-based and treats -1 as "to the last data row". Test with a small explicit range first.

exemplo de curl

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

O que significa o API retornar?

A JSON resultado cuja carga útil é o rowData variedade.

CampoTipoO que contém
rowDataArray of objectsThe primary output. Each entry is one extracted row as a JSON object, with column names or indexes as keys.
successBooleantrue when extraction succeeded. Check this before iterating rowData.
documentnullNull for this endpoint: no modified file is produced. Present only because the office family shares one response shape.
fileNamenullNull for this endpoint, for the same reason as document.
errorMessageStringPopulated when success is false: a missing worksheet, invalid Base64, or a corrupted workbook.
{
"document": null,
"fileName": null,
"success": true,
"errorMessage": null,
"rowData": [
{ "ColumnA": "value1", "ColumnB": "value2" },
{ "ColumnA": "value3", "ColumnB": "value4" }
]
}

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

Why are document and fileName null in the response?+
Because Extract Rows returns data, not a modified workbook. The primary output is the rowData array of row objects; the file-oriented fields exist in the shared response shape but stay null for this endpoint.
Are row indexes 0-based or 1-based?+
The extraction engine behind this action counts rows and columns 0-based, so row 0 is Excel row 1, and -1 means read to the last data row or column. If your range seems off by one, this is why.
Can I pipe the output into a database or another API?+
Yes, that is the point of the endpoint. rowData is plain JSON: each array entry is one row as an object, ready for an INSERT statement, an HTTP POST, or any downstream transformation.
What happens if I send an empty action object?+
The action still runs: the API reads the default worksheet and returns its rows. Add worksheetName or a row range only when you need to narrow the extraction.
Does this endpoint modify my Excel file?+
No. It is read-only. The source workbook is parsed, the rows are serialized to JSON, and no modified file is produced or returned.
Can I read a password-protected workbook?+
No. Protection blocks parsing. Chain the Unlock Excel action first with the correct password, then extract from the unlocked copy.
How do I extract whole worksheets instead of rows?+
Use the Extract Worksheets action, which splits worksheets out of the workbook. Extract Rows is for reading row values as JSON; Extract Worksheets is for separating sheets as workbook content.

Por que extrair? Excel dado API em vez de manualmente?

O método manual consiste em abrir a planilha, selecionar o intervalo, copiá-lo para algum lugar e redimensioná-lo manualmente, uma vez por arquivo, a cada atualização. API lê as mesmas linhas que uma solicitação determinística e te entrega. JSON que qualquer language analisa nativamente, sem Excel instalação no servidor. Porque a fonte permanece um padrão Escritório aberto XML Se a planilha e a operação forem somente leitura, a mesma chamada pode ser executada com segurança em um agendamento em arquivos ativos.

Ações relacionadas

A mesma tarefa em outras plataformas.

Obtenha ajuda