Skip to main content

Lidando com arquivos

O InHire possui uma API para lidar com arquivos, essa API é utilizada para enviar e baixar arquivos de um candidato.

Upload de arquivos​

O upload de arquivos é feito através da API de upload de arquivos. Você deve:

1. Obter URL assinada para o upload do arquivo​

Obter URL assinada para o upload do arquivo

Você receberá como retorno como nesse exemplo:

{
  "id": "d7c84543-7c8f-42d0-bf0d-d7e28e641394",
  "url": "https://s3.amazonaws.com/files.inhire.app",
  "fields": {
    "Key": "resumes/demo/TESTE-DE-CURRICULO*d7c84543-7c8f-42d0-bf0d-d7e28e641394.pdf",
    "Content-Type": "application/pdf",
    "bucket": "files.inhire.app",
    "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
    "X-Amz-Credential": "xxxxxxx",
    "X-Amz-Date": "20250310T214949Z",
    "X-Amz-Security-Token": "xxxxxxxx",
    "Policy": "xxxxxxxx",
    "X-Amz-Signature": "xxxxxxx"
  }
}

2. Realizar o upload do arquivo para a URL obtida​

Esses dados recebidos serão utilizados para realizar o upload do arquivo para o S3. Que deve ser um POST com para o url retornado:

POST https://s3.amazonaws.com/files.inhire.app

O Body deve ser em formato form-data com os campos:

Key
Content-Type
bucket
X-Amz-Algorithm
X-Amz-Credential
X-Amz-Date
X-Amz-Security-Token
X-Amz-Signature
Policy
file

Quando faz o upload recebe um retorno 204 No-Content.

3. Atualizar o candidato com o arquivo​

Atualizar o candidato com o arquivo

No corpo da atualização você deve mandar:

{
  "files": [
    {
      "name": "TESTE-DE-CURRICULO.pdf",
      "fileCategory": "resumes",
      "id": "d7c84543-7c8f-42d0-bf0d-d7e28e641394"
    }
  ]
}

O ID é o id do arquivo que você recebeu no retorno da geração da URL assinada.

Download de arquivos​

O download de arquivos é feito através da geração de uma URL assinada, que é válida por apenas 2 minutos. Obter URL assinada

Ao pegar um Candidato você receberá um atributo chamado files que é um array de arquivos, assim como no exemplo abaixo:

{
  "files": [
    {
      "name": "TESTE-DE-CURRICULO.pdf",
      "fileCategory": "resumes",
      "id": "d7c84543-7c8f-42d0-bf0d-d7e28e641394"
    }
  ]
}

Você deve gerar uma URL assinada para o arquivo que deseja baixar compondo a URL com o id do arquivo e a extensão do arquivo.

GET https://api.inhire.app/files/signature/{categoria}/{nome-do-arquivo}*{id-do-arquivo}.{extensao-do-arquivo}

Exemplo:

GET https://api.inhire.app/files/signature/resumes/TESTE-DE-CURRICULO*d7c84543-7c8f-42d0-bf0d-d7e28e641394.pdf

Você receberá uma URL assinada do arquivo que é válida por apenas 2 minutos.

https://s3.amazonaws.com/files.inhire.app/resumes/demo/TESTE-DE-CURRICULO*d7c84543-7c8f-42d0-bf0d-d7e28e641394.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxx&X-Amz-Date=20250310T214949Z&X-Amz-Security-Token=xxxxxxxx&X-Amz-Signature=xxxxxxx&X-Amz-Expires=120