5.1. Arquivos

Autenticação

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

Key	Value
apikey	{{apikey}}

aviso

Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.

---

Ambientes e URLs Base

As rotas nesta documentação são relativas. A URL base é gerenciada pela variável de coleção {{baseUrl}}.

Variável	Serviço	Ambiente	Valor
baseUrl	API Principal	Produção	https://api-drive.ajin.io

---

POST Upload de Arquivos por URL

/v3/files/upload-by-url

Realiza o upload de um arquivo a partir de uma URL pública, armazenando-o na plataforma para uso posterior (ex: anexar documentos a uma proposta).

Parâmetros do Body

Visualizar Parâmetros

Campo	Tipo	Obrigatório	Descrição
url	string (URL)	Sim	URL pública do arquivo a ser importado

Exemplo de Requisição e Resposta

Body

Visualizar Body

{
  "url": "https://dieghernan.github.io/assets/img/samples/sample_1.3mb.jpg"
}

cURL

Visualizar cURL

curl --location '/v3/files/upload-by-url' \
--header 'apikey: {{apikey}}' \
--header 'Content-Type: application/json' \
--data '{
  "url": "https://dieghernan.github.io/assets/img/samples/sample_1.3mb.jpg"
}'

200 - Sucesso

Visualizar Response

{
    "id": "8fa2c114-223e-4a06-96b9-5852b74fcabe",
    "code": 2598,
    "key": "files/0082430e-decd-4415-81c3-ceef39500cc7.jpg",
    "feature": {
        "code": 100501,
        "name": "Arquivo"
    },
    "parent": {
        "id": "00000000-0000-0000-0000-000000000000",
        "code": 0,
        "name": null
    },
    "type": {
        "code": "file",
        "name": "Arquivo"
    },
    "name": "11ce789b-9492-4ad6-9bf4-0ec6b75212f2.jpg",
    "info": {
        "name": "sample_1.3mb.jpg",
        "extension": "jpg",
        "directory": "",
        "size": 1374693,
        "type": "image/jpeg",
        "creationDate": null,
        "changeDate": null,
        "lastAccess": null
    },
    "url": "https://ajinsoft.s3.sa-east-1.amazonaws.com/files/0082430e-decd-4415-81c3-ceef39500cc7.jpg",
    "size": 1374693,
    "note": "",
    "referenceCode": null,
    "status": {
        "code": 0,
        "key": null,
        "name": "",
        "date": "2026-02-26 15:37",
        "color": "#9E9E9E",
        "note": null
    },
    "fields": [],
    "access": "public-read"
}

400 - Erro

Visualizar Response

{
    "messages": [
        {
            "code": "9999999",
            "text": "Erro interno"
        }
    ]
}

---

GET Selecionar Arquivo pelo ID

/v3/files/{{file_id}}

Retorna os dados e metadados de um arquivo previamente enviado, a partir do seu identificador único.

Parâmetros de Rota (Path)

Variável	Descrição
{{file_id}}	UUID do arquivo retornado no upload (id)

Exemplo de Requisição e Resposta

cURL

Visualizar cURL

curl --location --request GET '/v3/files/{{file_id}}' \
--header 'apikey: {{apikey}}'

200 - Sucesso

Visualizar Response

{
    "id": "8fa2c114-223e-4a06-96b9-5852b74fcabe",
    "code": 2598,
    "key": "files/0082430e-decd-4415-81c3-ceef39500cc7.jpg",
    "feature": {
        "code": 100501,
        "name": "Arquivo"
    },
    "parent": {
        "id": "00000000-0000-0000-0000-000000000000",
        "code": 0,
        "name": null
    },
    "type": {
        "code": "file",
        "name": "Arquivo"
    },
    "name": "11ce789b-9492-4ad6-9bf4-0ec6b75212f2.jpg",
    "info": {
        "name": "sample_1.3mb.jpg",
        "extension": "jpg",
        "directory": "",
        "size": 1374693,
        "type": "image/jpeg",
        "creationDate": null,
        "changeDate": null,
        "lastAccess": null
    },
    "url": "https://ajinsoft.s3.sa-east-1.amazonaws.com/files/0082430e-decd-4415-81c3-ceef39500cc7.jpg",
    "size": 1374693,
    "note": "",
    "referenceCode": null,
    "status": {
        "code": 0,
        "key": null,
        "name": "",
        "date": "2026-02-26 15:37",
        "color": "#9E9E9E",
        "note": null
    },
    "fields": [],
    "access": "public-read"
}

400 - Erro

Visualizar Response

{
    "messages": [
        {
            "code": "9001002",
            "text": "Parâmetros inválidos"
        }
    ]
}