Pular para o conteúdo principal

Primeiros passos

Este guia mostra o caminho feliz para a primeira integração. A referência completa de cada endpoint está no Swagger.

1. Obtenha uma chave de API​

No MakePro, abra Empresa → Chaves de API (ou Perfil → Minhas chaves) e crie uma chave com os scopes necessários.

Veja os detalhes em Autenticação e chaves.

2. Descubra empresa e projeto​

Toda rota de projeto exige um company_id ou project_id. Comece pela descoberta:

curl -s \
  -H "Authorization: Bearer mkp_SUA_CHAVE" \
  https://api-public.makepro.com.br/api/v1/companies

Depois liste os projetos da empresa:

curl -s \
  -H "Authorization: Bearer mkp_SUA_CHAVE" \
  "https://api-public.makepro.com.br/api/v1/companies/{company_id}/projects"

3. Acesse o domínio desejado​

Com o project_id em mãos, use a rota curta /projects/{pid}/... na maioria dos casos:

# Pastas do projeto
GET /api/v1/projects/{pid}/folders

# Documentos na raiz (veja a armadilha abaixo)
GET /api/v1/projects/{pid}/documents

# Tópicos BCF
GET /api/v1/bcf/2.1/projects/{pid}/topics

No Swagger, cada grupo de endpoints mostra parâmetros de filtro, paginação e exemplos de resposta.

4. Baixe um arquivo (dois passos)​

O download de documento não devolve o arquivo diretamente. Primeiro você obtém um link temporário:

# 1) Pedir URL assinada
GET /api/v1/projects/{pid}/documents/{document_id}/download

# 2) Baixar o arquivo (sem header Authorization)
GET {download_url}

O link expira em cerca de 1 hora.

Armadilhas comuns​

  1. GET /projects/{pid}/documents lista só a raiz. Sem include_all_folders=true, um projeto com pastas pode retornar total: 0.
  2. Tamanho do arquivo não está no documento. O campo size vive na versão (/documents/{id}/versions).
  3. Cronograma só na rota longa. Use /companies/{cid}/projects/{pid}/schedules.

Explore no Swagger​

Abra a referência interativa e teste com a sua chave:

api-public.makepro.com.br/api/docs

No Swagger, clique em Authorize e informe Bearer mkp_... para executar chamadas direto no navegador.