Lista de Documentos
Gestão de API Keys Chamadas de API
Nesta Página
> recursos > docs > api > chamadas api > Chamadas de API

Chamadas de API

Como Fazer Chamadas de API na ProcessMind

Veja exemplos e dicas para usar a API ProcessMind. Aprenda a consultar dados, enviar informações ou automatizar workflows de forma simples. Veja documentação, endpoints, autenticação, exemplos, formatos de resposta e integração passo a passo em nossa Documentação da API no GitHub.

Variáveis de Autenticação

  • apiKey Inclua sua API key no cabeçalho de todas as requisições. A chave está em Configurações da sua conta ProcessMind.
  • tenantId Alguns endpoints exigem o Tenant ID, exclusivo da sua organização e disponível no painel da conta.
  • datatableId Para datasets, forneça o Datatable ID. Ele fica nas configurações do dataset em [Get Data Table ID] dentro do ProcessMind.

Upload Direto de Arquivos

ProcessMind permite subir arquivos direto nas datatables usando presigned URLs. Isso garante segurança, pois não expõe sua API key nem outros dados sensíveis. Lembre: as presigned URLs expiram rápido e precisam ser usadas logo após geradas. Para acessar, faça um GET no endpoint. A URL pode ser pega no menu do dataset em [Get upload URL] no ProcessMind. O prazo pode ser definido entre 1 hora, 1 semana ou até 1 mês.

Visão Geral dos Endpoints da API

MétodoEndpointDescrição
GET/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurlRetorna uma URL temporária (pre-signed) para upload de arquivo em uma datatable.
GET/tenant/{tenantId}/datasetsRetorna a lista de datasets do tenant.
GET/tenant/{tenantId}Retorna detalhes do tenant.
GET/tenant/{tenantId}/organizationRetorna informações sobre a organização do tenant.

URL Base da API

Todas as requisições à API devem ser feitas nesta URL base: https://api.processmind.com

Como Obter uma URL de Upload Pre‑signed

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Parâmetros:

  • tenantId – ID do tenant (string).
  • datatableId – ID da datatable para upload (string).
  • apiKey – Sua API key (string).

Retorna:
Um objeto de resposta com PreSignedUploadUrl, uma URL temporária para upload direto (geralmente via HTTP PUT).

Exemplo (usando helper):

const presignedUrl = await getPresignedUploadUrl({
	apiKey,
	tenantId: "tenant-123",
	datatableId: "table-456"
});
console.log(presignedUrl); // ex: https://s3.amazonaws.com/…?X-Amz-Signature=…

Como Listar Datasets

Endpoint: GET /tenant/{tenantId}/datasets
Parâmetros:

  • tenantId – ID do tenant.
  • apiKey – Sua API key.

Retorna:
Um array com objetos dataset do tenant.

Exemplo:

const datasets = await getDatasets({
	apiKey,
	tenantId: "tenant-123"
});
console.log(datasets);

Como Ver Detalhes do Tenant

Endpoint: GET /tenant/{tenantId}
Parâmetros:

  • tenantId – ID do tenant.
  • apiKey – Sua API key.

Retorna:
Um objeto com dados do tenant, como nome, data de criação e plano.

Exemplo:

const tenantInfo = await getTenant({
	apiKey,
	tenantId: "tenant-123"
});
console.log(tenantInfo);

Como Ver Detalhes da Organização

Endpoint: GET /tenant/{tenantId}/organization
Parâmetros:

  • tenantId – ID do tenant.
  • apiKey – Sua API key.

Retorna:
Informações sobre a organização do tenant (ex.: nome da empresa, endereço, contatos).

Exemplo:

const org = await getOrganization({
	apiKey,
	tenantId: "tenant-123"
});
console.log(org);

Como Fazer Upload de Arquivo

A função uploadFile mostra como subir um arquivo usando uma URL pre‑signed. O fluxo geral é:

  1. Obtenha a URL pre‑signed pelo getPresignedUploadUrl.
  2. Faça um PUT nessa URL com o arquivo. A URL já autoriza o upload direto para o storage, sem outras credenciais.
  3. (Opcional) Notifique sua API sobre a conclusão, se o back-end exigir.

Veja exemplo simples usando fetch:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
	// Passo 1: Obter pre-signed URL
	const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
	
	// Passo 2: Subir o arquivo via PUT
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Type": file.type
		},
		body: file
	});
	
	// Passo 3: Opcionalmente notifique sua API
	// (depende do seu back-end)
}

info

  • URLs pre-signed expiram rápido (em minutos). Use logo após gerar.
  • Se o upload falhar (ex: internet caiu), gere nova pre-signed URL para tentar de novo.
  • Sempre mantenha sua apiKey segura e nunca exponha em client-side público, como front-end.

Exemplo em Bash: Upload de Arquivo

Script Bash simples para subir um arquivo no ProcessMind usando dois comandos curl, com espaços para todos os valores.

Baixar Exemplo BASH
#!/bin/bash
# Script Bash simples para enviar um arquivo ao ProcessMind usando dois comandos curl, com placeholders para todos os valores

# Substitua os placeholders abaixo pelos seus valores reais:
# <API_KEY>, <TENANT_ID>, <DATATABLE_ID>, <FILE_PATH>

curl -s -H "x-api-key: <API_KEY>" \
	"https://api.processmind.com/tenant/<TENANT_ID>/datatable/<DATATABLE_ID>/uploads/presignedurl" \
	| grep -oP '"PreSignedUploadUrl"\s*:\s*"\K[^"]+' \
	| xargs -I {} curl -s -X PUT --upload-file "<FILE_PATH>" "{}"

Exemplo Node.js: Upload de CSV Local

Faz upload de arquivo CSV local no ProcessMind via presigned URL.

Passos:

  1. Busque a presigned upload URL na API.
  2. Leia o arquivo do disco.
  3. Envie o arquivo via HTTP PUT para a URL.

Configuração:

  • Informe API key, tenantId, datatableId e filePath ao rodar uploadFileToProcessMind().
  • A URL base da API é https://api.processmind.com
Baixar Exemplo NodeJS
/**
 * Faz upload de um arquivo CSV local para o ProcessMind usando uma URL pré-assinada.
 *
 * Passos:
 * 1. Busque uma URL pré-assinada de upload na API.
 * 2. Leia o arquivo local do disco.
 * 3. Faça o upload pela URL pré-assinada usando HTTP PUT.
 *
 * Configuração:
 * - Informe sua API key, tenantId, datatableId e filePath ao usar uploadFileToProcessMind().
 * - A URL base da API é https://api.processmind.com
 */

const fs = require("node:fs");

/**
 * Faz upload de um arquivo para a datatable do ProcessMind via URL pré-assinada.
 * @param {string} apiKey - Sua API key para autenticação.
 * @param {string} tenantId - Id. do tenant.
 * @param {string} datatableId - Id. da datatable.
 * @param {string} filePath - Caminho do arquivo para upload.
 */

async function getApi({path, apiKey, apiUrl = "https://api.processmind.com"}) {
	try {
        const response = await fetch(`${apiUrl}${path}`, {
            method: "GET",
            headers: {
                "x-api-key": apiKey
            }
        });
        const body = await response.json();
        if (!response.ok) {
            console.error(`Erro ao acessar a API: ${response.status}, ${response.statusText}: ${body.message}`);
            return;
        }
        return body;
    } catch (err) {
        console.error("Erro inesperado:", err);
    }
}

async function getPresignedUploadUrl({apiKey, tenantId, datatableId, apiUrl = "https://api.processmind.com"}) {
	return (await getApi({apiKey, path: `/tenant/${tenantId}/datatable/${datatableId}/uploads/presignedurl`, apiUrl})).PreSignedUploadUrl;
}

async function getDatasets({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/tenant/${tenantId}/datasets`, apiUrl});
}

async function getTenant({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/tenant/${tenantId}`, apiUrl});
}

async function getOrganization({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/tenant/${tenantId}/organization`, apiUrl});
}

async function uploadFile({apiKey, tenantId, datatableId, filePath, apiUrl = "https://api.processmind.com"}) {
    try {
        const uploadUrl = await getPresignedUploadUrl({apiKey, tenantId, datatableId, apiUrl});

		console.log("Enviando arquivo...");
        fs.readFile(filePath, async (err, data) => {
            if (err) {
                console.error("Erro ao ler o arquivo:", err);
                return;
            }
            try {
                const uploadRes = await fetch(uploadUrl, {
                    method: "PUT",
                    body: data
                });
                if (!uploadRes.ok) {
                    console.error("Falha no upload:", uploadRes.status, uploadRes.statusText);
                } else {
                    console.log("Arquivo enviado com sucesso.");
                }
            } catch (uploadErr) {
                console.error("Erro ao enviar arquivo:", uploadErr);
            }
        });
    } catch (err) {
        console.error("Erro inesperado:", err);
    }
}

// Exporta as funções para uso em outros módulos
module.exports = { 
	getPresignedUploadUrl,
	getDatasets,
	getTenant,
	getOrganization,
	uploadFile 
};

Exemplo Python: Upload de CSV Local

Faz upload de um arquivo CSV local para a API usando uma presigned URL.

Passos:

  1. Obtenha a presigned upload URL pela API.
  2. Leia o arquivo local no disco.
  3. Faça upload para a URL usando HTTP PUT.

Configuração:

  • Atualize api_key, tenant_id, datatable_id e file_path conforme necessário.
Baixar Exemplo Python
"""
Envia um arquivo CSV local para uma API remota usando uma URL pré-assinada.

Passos:
1. Busque uma URL pré-assinada de upload na API.
2. Leia o arquivo local do disco.
3. Faça upload pela URL pré-assinada usando HTTP PUT.

Configuração:
- Atualize api_key, tenant_id, datatable_id e file_path conforme necessário.
"""

import requests

# === Configuração ===
api_key = ""  # API key para autenticação
tenant_id = ""  # Identificador do tenant
datatable_id = ""  # Identificador da datatable
file_path = ""  # Caminho do arquivo para upload


print("Buscando URL para upload...")
api_url = "https://api.processmind.com"  # Base API URL
presign_url = f"{api_url}/tenant/{tenant_id}/datatable/{datatable_id}/uploads/presignedurl"
presign_res = requests.get(presign_url, headers={"x-api-key": api_key})
if not presign_res.ok:
	print(f"Erro ao buscar URL de upload: {presign_res.status_code}, {presign_res.reason}: {presign_res.text}")
	exit(1)

presign_body = presign_res.json()
upload_url = presign_body.get("PreSignedUploadUrl")
if not upload_url:
	print("Nenhuma URL presignada de upload foi retornada.")
	exit(1)

print("Enviando arquivo...")
with open(file_path, "rb") as f:
	upload_res = requests.put(upload_url, data=f)
if not upload_res.ok:
	print(f"Falha no upload: {upload_res.status_code}, {upload_res.reason}")
else:
	print("Arquivo enviado com sucesso.")

info

Para ver a documentação detalhada da API, com todos os endpoints disponíveis, autenticação, exemplos e guias passo a passo, acesse nossa Documentação da API no GitHub. Precisa de ajuda ou tem dúvidas sobre a API? Fale com nosso suporte ou participe da nossa comunidade de desenvolvedores.

Documentação Relacionada