Pular para o conteúdo principal

Usando a Documentação Interativa

Aprenda como usar nossa documentação interativa baseada em OpenAPI em docs.intelliscreen.io para testar e explorar os endpoints da API.

Começando com a Documentação​

Nossa documentação da API é construída usando especificações OpenAPI, fornecendo uma interface interativa para testar endpoints diretamente do seu navegador.

Interface de Documentação Interativa Visão geral da interface de documentação interativa

Métodos de Autenticação​

Você tem duas opções para se autenticar com a documentação interativa:

Opção 1: Autenticação Global​

  1. Localize o ícone de cadeado no canto superior direito da página de documentação
  2. Clique no ícone de cadeado para abrir o diálogo de autenticação
  3. Digite sua chave API no campo de autenticação
  4. Clique em "Authorize" para autenticar todos os endpoints

Autenticação Global Autorize-se com sua chave API

Opção 2: Autenticação de Endpoint Individual​

  1. Navegue para qualquer endpoint que você queira testar
  2. Procure pelo ícone de cadeado ao lado do endpoint localizado no extremo direito
  3. Clique no ícone de cadeado para esse endpoint específico
  4. Digite sua chave API para autenticar apenas esse endpoint

Autenticação de Endpoint Individual Ícone de cadeado de autenticação para endpoints individuais

Testando Endpoints​

Uma vez autenticado, você pode testar qualquer endpoint seguindo estes passos:

Passo 1: Selecionar um Endpoint​

Navegue até o endpoint que você quer testar a partir da barra lateral de documentação ou página principal.

Passo 2: Experimente​

  1. Clique no botão "Try it out" no endpoint desejado
  2. Isso habilitará os campos de parâmetros para edição

Botão Try It Out Localização do botão "Try it out" nas páginas de endpoints

Passo 3: Preencher Informações Obrigatórias​

  1. Revise os parâmetros obrigatórios para o endpoint
  2. Preencha os campos obrigatórios com valores apropriados
  3. Opcionalmente preencha parâmetros opcionais conforme necessário para seu teste

Passo 4: Executar a Solicitação​

  1. Clique no botão "Execute" para enviar a solicitação
  2. Visualize a resposta na seção de resposta abaixo
  3. Analise os resultados incluindo código de status, corpo da resposta e cabeçalhos

Entendendo as Respostas​

A documentação interativa mostra:

Informações da Resposta​

  • Código de Status: Código de status HTTP (200, 404, 422, etc.)
  • Corpo da Resposta: A resposta JSON real da API
  • Cabeçalhos da Resposta: Cabeçalhos retornados pela API
  • Detalhes da Solicitação: A solicitação exata que foi enviada

Exemplos de Resposta​

Cada endpoint inclui exemplos de resposta para diferentes cenários:

  • Respostas bem-sucedidas (códigos de status 200)
  • Respostas de erro (códigos de status 400, 404, 422, 500)
  • Diferentes formatos de resposta baseados no endpoint

Exemplos de Resposta Formatos de resposta de exemplo mostrados na documentação

Cenários Comuns de Teste​

Testando Endpoints GET​

  1. Autentique-se usando seu método preferido
  2. Clique em "Try it out" no endpoint GET
  3. Preencha quaisquer parâmetros de caminho obrigatórios (como candidate_id)
  4. Clique em "Execute" para recuperar dados

Testando Endpoints POST​

  1. Autentique-se e clique em "Try it out"
  2. Preencha parâmetros obrigatórios e corpo da solicitação
  3. Para uploads de arquivo, use a interface de seleção de arquivo
  4. Clique em "Execute" para enviar dados

Testando com Parâmetros de Consulta​

  1. Procure por parâmetros de consulta na seção de parâmetros
  2. Preencha parâmetros de consulta opcionais como page para paginação
  3. Execute para ver como os parâmetros afetam a resposta

Usando a API Fora da Interface​

Ao integrar a API em suas próprias aplicações (fora desta interface OpenAPI), você precisará incluir manualmente sua chave API nos cabeçalhos da solicitação.

Cabeçalhos Obrigatórios​

Toda solicitação da API deve incluir estes cabeçalhos:

X-API-Key: SUA_CHAVE_API_AQUI
Content-Type: application/json

Exemplo cURL​

curl -X GET "https://api.intelliscreen.io/candidates/" \
  -H "X-API-Key: SUA_CHAVE_API_AQUI" \
  -H "Content-Type: application/json"

Exemplo JavaScript​

const response = await fetch("https://api.intelliscreen.io/candidates/", {
  method: "GET",
  headers: {
    "X-API-Key": "SUA_CHAVE_API_AQUI",
    "Content-Type": "application/json",
  },
});

const data = await response.json();

Exemplo Python​

import requests

headers = {
    'X-API-Key': 'SUA_CHAVE_API_AQUI',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.intelliscreen.io/candidates/', headers=headers)
data = response.json()

Importante: Substitua SUA_CHAVE_API_AQUI pela sua chave API real do painel da sua conta.

Dicas para Testes Eficazes​

Teste de Parâmetros​

  • Comece com parâmetros obrigatórios: Sempre preencha primeiro os parâmetros obrigatórios
  • Teste casos extremos: Experimente valores limítrofes e casos extremos
  • Use dados realistas: Use e-mails, nomes e IDs de candidatos realistas

Teste de Erros​

  • Teste dados inválidos: Experimente IDs inválidos ou solicitações mal formadas
  • Verifique permissões: Teste endpoints aos quais você pode não ter acesso
  • Verifique mensagens de erro: Certifique-se de que as respostas de erro sejam úteis

Validação de Resposta​

  • Verifique códigos de status: Verifique se você está obtendo os códigos de status esperados
  • Valide estrutura da resposta: Certifique-se de que a resposta corresponde ao esquema
  • Teste paginação: Para endpoints paginados, teste diferentes números de página

Solução de Problemas Comuns​

Problemas de Autenticação​

  • Verifique sua chave API: Certifique-se de que está copiada corretamente
  • Tente ambos os métodos de autenticação: Se a autenticação global falhar, tente a autenticação de endpoint individual
  • Verifique chaves expiradas: Regenere sua chave API se necessário

Problemas de Parâmetros​

  • Obrigatórios vs opcionais: Certifique-se de que todos os parâmetros obrigatórios estejam preenchidos
  • Tipos de dados: Corresponda aos tipos de dados esperados (string, integer, etc.)
  • Validação de formato: Siga quaisquer formatos especificados para parâmetros

Problemas de Rede​

  • Verifique sua conexão: Certifique-se de ter uma conexão de internet estável
  • Teste diferentes endpoints: Teste se o problema é específico do endpoint
  • Limpe o cache do navegador: Às vezes dados em cache podem causar problemas