Pular para o conteúdo principal

API de Perfil Compartilhado

O endpoint de Perfil Compartilhado fornece informações abrangentes do candidato dentro de um contexto de posição específico, combinando detalhes pessoais, resultados de avaliação e dados detalhados de desempenho de testes.

Endpoint Disponível​

EndpointMétodoDescrição
/shared/{candidate_id}/{position_id}GETObter perfil completo do candidato e informações da posição

Propósito do Endpoint​

Este endpoint fornece uma visão completa de avaliação do candidato combinando:

  • Informações Pessoais: Nome, e-mail, telefone e detalhes de contato
  • Detalhes do Currículo: Experiência, habilidades, educação e propriedades do currículo analisadas
  • Resultados de Avaliação: Pontuações gerais, avaliações geradas por IA e dados específicos da posição
  • Desempenho de Testes: Resultados detalhados em nível de pergunta com respostas do candidato e correção
  • Acesso a Arquivos: URLs de avatar e arquivo de currículo para registros completos do candidato

Casos de Uso​

Preparação de Entrevistas​

  • Acessar perfis completos de candidatos antes de entrevistas
  • Revisar resultados detalhados de testes e métricas de desempenho
  • Analisar correspondências de habilidades e experiência para a posição

Avaliação de Candidatos​

  • Obter visão geral completa de avaliação incluindo insights gerados por IA
  • Comparar desempenho do candidato através de diferentes componentes de teste
  • Acessar tanto pontuações quantitativas quanto dados de avaliação qualitativa

Relatórios e Documentação​

  • Gerar relatórios detalhados de candidatos com todas as informações disponíveis
  • Criar resumos de avaliação abrangentes
  • Documentar decisões de contratação com contexto completo do candidato

Estrutura de Resposta​

Seção de Perfil​

Contém informações pessoais do candidato e detalhes do currículo:

{
  "profile": {
    "personal_info": {
      "id": "candidate-uuid",
      "name": "John Smith",
      "email": "john.smith@example.com",
      "phone": "+1-555-123-4567"
    },
    "last_activity": "2023-06-05T14:30:00Z",
    "resume_properties": {
      "language": "English",
      "location_country": "United States",
      "location_city": "Boston",
      "latest_job_title": "Senior Software Engineer"
    },
    "skills": [
      { "skill": "Python", "years_experience": "5+" },
      { "skill": "React", "years_experience": "3" }
    ],
    "avatar_url": "https://storage.example.com/avatars/candidate.jpg",
    "resume_urls": ["https://storage.example.com/resumes/resume.pdf"]
  }
}

Seção de Testes​

Fornece resultados detalhados de testes com dados em nível de pergunta:

{
  "tests": [
    {
      "id": "test123",
      "name": "Python Programming",
      "type": "Technical Skills",
      "sub_type": "Coding",
      "score": 85,
      "questions": [
        {
          "id": "q1",
          "question": "What is a Python decorator?",
          "type": "Multiple Choice",
          "options": ["Option A", "Option B", "Option C"],
          "candidate_answer": "A function that takes another function as an argument",
          "is_correct": "true"
        }
      ]
    }
  ]
}

Seção de Resultados da Posição​

Contém informações de avaliação específicas da posição:

{
  "position_results": {
    "id": "assessment123",
    "name": "Software Engineer Assessment",
    "job_title": "Senior Python Developer",
    "status": "Completed",
    "created_at": "2023-06-01T10:00:00Z",
    "completed_at": "2023-06-02T15:30:00Z",
    "ai_score": "87",
    "ai_score_desc": "Strong match for the position",
    "overall_score": 85,
    "salary_expectation": 120000,
    "salary_expectation_currency": "USD"
  }
}

Dados Disponíveis​

Informações Pessoais​

  • Detalhes básicos de contato (nome, e-mail, telefone)
  • Timestamp da última atividade
  • URL da imagem do avatar

Análise de Currículo​

  • Propriedades do currículo analisadas (localização, título do trabalho, idioma)
  • Habilidades extraídas com anos de experiência
  • URLs de arquivo de currículo para acesso a documentos
  • Conteúdo de texto bruto do currículo

Desempenho de Avaliação​

  • Pontuação geral da avaliação
  • Pontuação e descrição geradas por IA
  • Status e cronologia da avaliação
  • Expectativas salariais e moeda

Resultados de Testes​

  • Pontuações e desempenho de testes individuais
  • Detalhes completos de perguntas e respostas
  • Indicadores de correção de respostas
  • Categorização de testes (tipo e subtipo)

Requisitos de Acesso​

Autenticação​

  • Chave API válida necessária para todas as solicitações
  • Candidato deve estar associado a uma posição na sua organização
  • Posição deve pertencer à sua organização

Permissões​

  • Controle de acesso baseado em organização
  • Validação de propriedade da posição
  • Verificação de associação candidato-posição

Respostas de Erro​

403 - Acesso Negado​

Ocorre quando:

  • A posição não pertence à sua organização
  • O candidato não está associado à posição especificada
  • Permissões insuficientes para acessar os dados

404 - Não Encontrado​

Ocorre quando:

  • ID do candidato não existe
  • ID da posição não existe
  • Associação candidato-posição não existe

500 - Erro do Servidor​

Ocorre quando:

  • Problemas de conectividade do banco de dados
  • Erros inesperados do sistema
  • Falhas no processamento de dados

Notas de Implementação​

Completude dos Dados​

  • Nem todos os candidatos podem ter informações de perfil completas
  • Propriedades do currículo dependem do processamento bem-sucedido da IA
  • Dados de habilidades requerem conclusão da análise do currículo
  • Resultados de testes só estão disponíveis após conclusão da avaliação

URLs de Arquivos​

  • URLs de avatar e currículo são pré-assinadas para acesso seguro
  • URLs têm tempos de expiração por segurança
  • Arquivos são armazenados com segurança com controles de acesso baseados em organização

Considerações de Desempenho​

  • Este endpoint retorna dados abrangentes e pode ter tempos de resposta mais longos
  • Considere fazer cache das respostas para perfis de candidatos acessados frequentemente
  • Use configurações de timeout apropriadas para chamadas da API

Este endpoint serve como uma fonte de dados abrangente para avaliação de candidatos, fornecendo todas as informações disponíveis em uma única chamada da API para fluxos de trabalho completos de avaliação de candidatos.