Sua primeira execução com a API
Execute um modelo sobre um arquivo a partir de um script e baixe o resultado.
O que você precisa
- Um modelo salvo, de Corrija seu primeiro arquivo.
- curl, ou qualquer cliente HTTP.
Passos
Crie uma chave
Na sua página de conta, clique em Criar uma chave. Copie-a agora: ela é mostrada só uma vez.
Guarde-a como variável de ambiente
Todo exemplo destas páginas lê a chave de
DOCTRANSFORM_API_KEY, nunca como um literal no comando:export DOCTRANSFORM_API_KEY=dt_live_...Liste seus modelos
Encontre o id do modelo que você quer executar.
curl "https://doctransform.xyz/api/v1/templates" \ -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"Crie uma execução
Envie um arquivo para executar esse modelo sobre ele.
curl -X POST "https://doctransform.xyz/api/v1/templates/tmpl_123/runs" \ -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \ -F "file=@/path/to/your/file.csv"Só uma execução que devolve um arquivo gasta uma das suas exportações do mês.
Consulte o status
Uma execução rápida responde
201com o resultado anexado. Uma mais longa responde202: consulteGET /runs/{id}até que o status deixe de serrunning.curl "https://doctransform.xyz/api/v1/runs/run_abc" \ -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"Baixe o resultado
Quando a execução tiver sido bem-sucedida, baixe a saída dela:
curl "https://doctransform.xyz/api/v1/runs/run_abc/output" \ -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \ -o result.csv