Ir para o conteúdo principal

API: FAQ

A documentação detalhada da API pode ser encontrada em https://documenter.getpostman.com/view/1801428/UVC6i6eA

Posso criar perfis em massa e adicionar cookies, extensões ou atribuir tags a eles?​

Você pode usar nossa API para criar perfis com cookies e configurações específicas de que precisa em massa. Isso pode ser feito ao programar um loop na linguagem de sua preferência, usando um arquivo de texto com cookies e outros dados necessários que podem ser processados ou divididos com métodos da linguagem de programação e, em seguida, passar esses parâmetros sequencialmente para a solicitação de criação de perfil.

A automação com estruturas de automação de navegador como Puppeteer, Pyppeteer, Playwright ou Selenium está disponível no Octo?​

Sim, você pode usar essas estruturas de automação. Você pode encontrar exemplos de código para iniciar um perfil e conectar uma estrutura/biblioteca a um perfil de execução em nossa documentação da API.

Iniciei um perfil usando a API, vejo "Auto" no botão "START" no aplicativo de clientes Octo, mas não vejo a interface do perfil.​

Verifique os argumentos iniciais do perfil e, especificamente, o parâmetro headless. Para que a interface do perfil seja exibida, esse parâmetro deve ser definido como falso.

É possível obter todos os nomes de perfis em uma conta usando a API?​

Sim, você pode usar o método GET Get Profiles da nossa documentação da API para fazer isso.

Se o senhor tiver mais de 100 perfis na sua conta, precisará alterar o número da página solicitada no URL da solicitação e também definir os parâmetros de saída dos campos como título. O senhor pode implementar isso codificando um loop na linguagem de programação de sua escolha.

Ao enviar uma solicitação GET para esse URL, você terá o UUID e o título de 100 perfis na primeira página.

https://app.octobrowser.net/api/v2/automation/profiles?page_len=100&page=0&fields=title

Atualmente, não é possível exportar totalmente todos os cookies de perfil usando a API. Só é possível exportar cookies da página atualmente aberta usando estruturas de automação (Selenium, Puppeteer, Playwright).

O Atendimento ao Cliente não pode oferecer consultoria nem ajudar você a obter cookies da página aberta em um perfil usando uma estrutura de automação do navegador.

Recebo o erro 429 ao executar uma solicitação​

Interrompa seu script e faça uma pausa nas solicitações. Os limites da API para sua conta podem ser encontrados nos cabeçalhos de resposta do servidor correspondentes.

Retry-After: 0 # Se esse valor for igual a 0, o senhor poderá enviar a próxima solicitação
X-Ratelimit-Limit: 200 # RPM - A quantidade total de solicitações por minuto
X-Ratelimit-Limit-Hour: 3000 # RPH - A quantidade total de solicitações por hora
X-Ratelimit-Remaining: 4 # remaining RPM - Solicitações restantes por minuto
X-Ratelimit-Remaining-Hour: 2999 # remaining RPH - Solicitações restantes por hora
X-Ratelimit-Reset: 1671789217 # unix timestamp - hora UNIX após a qual o limite será redefinido

IMPORTANTE!

Não envie solicitações se o senhor tiver esgotado seus limites: o tempo de restrição será estendido e restrições mais rigorosas poderão ser aplicadas. Verifique os cabeçalhos de limite em seus scripts antes de enviar uma solicitação.

Qual driver devo usar para o Selenium?​

O senhor precisa usar o driver Chromium com uma versão que corresponda à versão atual do kernel Octo. O senhor pode ver a versão atual do kernel digitando chrome://version na barra de endereços de um perfil em execução. Se um driver para o kernel mais recente ainda não tiver sido lançado, use o driver para a versão anterior.

Quais solicitações à API local serão contabilizadas no limite de solicitações permitidas?​

De todas as solicitações disponíveis na coluna API Local, somente a solicitação Iniciar Perfil será contabilizada nos limites de RPM (solicitações por minuto) e RPH (solicitações por hora).

As seguintes solicitações não são contadas para os limites de solicitações:

  • Listar perfis ativos
  • Perfil de parada
  • Force Stop Profile
  • Faça o login
  • Sair
  • Obter a versão do cliente
  • Atualizar cliente
  • Nome de usuário
  • Definir senha do perfil
  • Excluir senha do perfil

Como posso obter o UUID das extensões?​

O senhor pode obter o UUID das extensões de três maneiras:

A primeira maneira​

  1. Adicionar a extensão manualmente a qualquer perfil por meio da edição de perfil.
  2. Obtenha os parâmetros desse perfil por meio da API usando uma solicitação GET Get Profile.
  3. Na resposta do servidor, o senhor verá as configurações de perfil, incluindo os UUIDs dos ramais conectados.

A segunda maneira​

Use uma solicitação GET Get Extensions de nossa documentação.

A terceira maneira​

  1. Abra um perfil com a extensão conectada.
  2. Digite chrome://extensions/ na barra de endereços do perfil e pressione Enter.
  3. Clique no botão "Details" (Detalhes) da extensão necessária.
  4. Copie o UUID da extensão junto com sua versão do campo Source (Fonte) abaixo.

Como posso obter o UUID de um ícone?​

  1. Salvar o ícone em qualquer perfil.
  2. Execute uma solicitação GET Get Profile em nossa documentação para recuperar informações sobre o perfil no qual o senhor salvou o ícone.
  3. O senhor encontrará o UUID desse ícone na resposta do servidor no campo "image", que pode ser usado para adicionar o ícone a outros perfis.

Como posso fazer com que um perfil abra em tamanho real na inicialização?​

Para fazer com que a janela do perfil inicie em seu tamanho máximo quando o perfil for iniciado via API, o senhor pode usar o sinalizador --start-maximized nos argumentos de início do perfil.

flags: ["--start-maximized"]

É possível alterar o endereço IP do proxy com sua API?​

Se o seu proxy fornecer um link de alteração de endereço IP, você poderá fazer uma solicitação GET regular usando esse link. Nossa API não é necessária para isso.

Um exemplo de solicitação Python com a biblioteca de solicitações:

import requests
response = requests.get('link para alteração de endereço IP')

Um exemplo de solicitação do Node.js com a biblioteca Axios:

const axios = require('axios');
axios.get('link para alteração do endereço IP');

Ao usar a automação paralela de vários perfis ao mesmo tempo, os scripts não funcionam corretamente em janelas que estão fora de foco (em segundo plano).​

Tente adicionar o sinalizador --disable-backgrounding-occluded-windows aos argumentos de inicialização de seus perfis.

Por exemplo:

flags:["--disable-backgrounding-occluded-windows"]

O Cookie Robot não pode ser iniciado via API. Se o senhor usar a API, poderá implementar facilmente funcionalidades semelhantes ou até mais avançadas usando estruturas de automação (Puppeteer, Playwright, Selenium).

Passagem de parâmetros ao criar um perfil via API​

const body = {
title: "profile_title", /* campo obrigatório */
fingerprint: {
os: "mac", /* campo obrigatório, ou "win" */
os_arch: "arm", /* campo opcional, ou "x86", se o senhor quiser criar um perfil mac com CPU Intel*/
os_version: "13" /* campo opcional
   para perfis win - 10/11,
   para mac arm - 12/13/14/15,
   para mac x86 (Intel) - 12/13/14/15
   */
} 
}

Passagem de parâmetros adicionais em uma solicitação de criação de perfil:

  1. Para obter informações detalhadas, consulte a nossa documentação de API. Selecione a solicitação POST Create Profile e role para baixo até o bloco de código Body, onde o senhor pode ver a estrutura dos parâmetros aceitos.
  2. Crie um perfil e recupere seus parâmetros usando a solicitação GET Get Profile. Na resposta do servidor, o senhor verá a estrutura e os parâmetros do perfil.

Como adiciono páginas iniciais a perfis já criados em massa?​

Você pode usar nossa API para fazer isso. Você precisará obter os UUIDs dos perfis necessários e fazer uma solicitação PATCH de atualização de perfil para cada perfil que for passar pelas páginas iniciais exigidas. Nossa documentação da API oferece snippets para essas tarefas. Você pode modificá-los de acordo com sua tarefa específica.

Posso gerenciar tarefas de perfil usando a API?​

No momento, não oferecemos a funcionalidade de API para gerenciar tarefas de perfil.