Arquivos · Referência

Drive de Arquivos

Pastas e arquivos do Drive interno (metadados). Download em /v1/drive/{id}/download exige também a permissão de dados pessoais.

Permissão: driveAções: ler · criar · atualizarglobal (sem carteira)

GET/v1/driveListar GET/v1/drive/{id}Detalhar GET/v1/drive/{id}/conteudoRelação: Drive de Arquivos GET/v1/drive/{id}/downloadBaixar arquivo POST/v1/driveCriar pasta ou enviar arquivo PATCH/v1/drive/{id}Renomear ou mover

O objeto drive de arquivos

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`parent_id`	inteiro	parent id	filtro
`node_type`	texto (enum)	node type `folder` `file`	filtro
`name`	texto	Nome	ordenar
`mime_type`	texto	mime type	filtro
`size_bytes`	inteiro	size bytes	ordenar
`created_by_user_id`	inteiro	ID do usuário que criou
`created_by_name`	texto	created by name
`created_at`	data-hora	Criado em	ordenar

Exemplo do objeto200 OK

{
    "id": 1024,
    "parent_id": 512,
    "node_type": "folder",
    "name": "Maria Fernanda Souza",
    "mime_type": "texto",
    "size_bytes": 1,
    "created_by_user_id": 512,
    "created_by_name": "texto",
    "created_at": "2026-10-08T14:30:00-03:00"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `name`, `created_at`, `size_bytes` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `name`
`parent_id`	inteiro	parent id — valor exato ou lista separada por vírgula
`node_type`	texto (enum)	node type — valor exato ou lista separada por vírgula `folder` `file`
`mime_type`	texto	mime type — valor exato ou lista separada por vírgula
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (considera a data de criação)
`incluir`	texto	Só no detalhe. Relações: `conteudo`

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/drive?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/drive?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/drive?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/drive?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "parent_id": 512,
            "node_type": "folder",
            "name": "Maria Fernanda Souza",
            "mime_type": "texto",
            "size_bytes": 1,
            "created_by_user_id": 512,
            "created_by_name": "texto"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Use incluir para embutir relações (cada uma exige Ler no módulo relacionado).

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/drive/1024?incluir=conteudo" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/drive/1024?incluir=conteudo');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/drive/1024?incluir=conteudo', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/drive/1024?incluir=conteudo",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "parent_id": 512,
        "node_type": "folder",
        "name": "Maria Fernanda Souza",
        "mime_type": "texto",
        "size_bytes": 1,
        "created_by_user_id": 512,
        "created_by_name": "texto"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`conteudo`	Drive de Arquivos	lista paginada	`/v1/drive/{id}/conteudo`

POST Criar pasta ou enviar arquivo

Criar pasta ou enviar arquivo (conteúdo em base64, até 700 KB). Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`node_type`	enum	obrigatório	`folder` `file`
`name`	texto	obrigatório	(até 200 caracteres)
`parent_id`	inteiro	opcional	Pasta destino (null = raiz)
`conteudo_base64`	texto	opcional	Obrigatório para arquivo; até ~700 KB (até 960000 caracteres)
`mime_type`	texto	opcional	(até 120 caracteres)

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/drive" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"node_type":"folder","name":"Contratos 2026","parent_id":null}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/drive');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'node_type' => 'folder',
    'name' => 'Contratos 2026',
    'parent_id' => NULL,
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/drive', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "node_type": "folder",
      "name": "Contratos 2026",
      "parent_id": null
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/drive",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "node_type": "folder",
        "name": "Contratos 2026",
        "parent_id": None
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "parent_id": 512,
        "node_type": "folder",
        "name": "Maria Fernanda Souza",
        "mime_type": "texto",
        "size_bytes": 1,
        "created_by_user_id": 512,
        "created_by_name": "texto"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

PATCH Renomear ou mover

Renomear ou mover. Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`name`	texto	opcional	(até 200 caracteres)
`parent_id`	inteiro	opcional	Pasta de destino (null = raiz)

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X PATCH "https://apimapogos.sixinformatica.com/v1/drive/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Contratos 2026 - assinados"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/drive/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Contratos 2026 - assinados',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/drive/1024', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "name": "Contratos 2026 - assinados"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "PATCH",
    "https://apimapogos.sixinformatica.com/v1/drive/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "name": "Contratos 2026 - assinados"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "parent_id": 512,
        "node_type": "folder",
        "name": "Maria Fernanda Souza",
        "mime_type": "texto",
        "size_bytes": 1,
        "created_by_user_id": 512,
        "created_by_name": "texto"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}