Como usar a Apollo pela API da Clickmax
A API da Clickmax faz chamadas à Apollo.io para buscar pessoas e empresas e identificar contatos, com a mesma chave de API da Clickmax que você já usa nas outras chamadas. Você não precisa ter conta na Apollo: sem chave própria conectada, a Clickmax faz a chamada pela conta dela. Se preferir usar a sua conta Apollo, conecte a chave dela ao workspace, e as chamadas passam a gastar os créditos e a contar nos limites da sua conta Apollo.
Antes de começar, você precisa de:
- uma chave de API do workspace da Clickmax (veja Autenticação na API da Clickmax);
- só para usar a sua conta Apollo: uma chave de API da Apollo, criada nas configurações da sua conta Apollo, com acesso aos endpoints que você vai usar, e permissão para gerenciar integrações no workspace.
A conexão com a Apollo existe só pela API. Ela não aparece na tela de Integrações.
Os exemplos usam o SDK TypeScript. Pela API HTTP, os caminhos são os mesmos, sob /api/v0/apollo/. As respostas trazem o corpo da Apollo sem mudanças dentro de data.
Usar a sua conta Apollo (opcional)
A Clickmax confere a chave com a Apollo antes de guardar, sem gastar créditos. Uma chave recusada não é guardada. Conectar de novo troca a chave anterior. Cada workspace tem uma chave Apollo.
clickmax.apollo.status()mostra se há uma chave conectada, sem consultar a Apollo. O campobillingdiz qual conta as chamadas usam:own_key(a sua conta Apollo) ouclickmax_credits(a conta da Clickmax).clickmax.apollo.health()confere de novo a chave guardada com a Apollo. Use nas telas de teste de conexão. Sem chave conectada, volta o erroapollo_not_connected.clickmax.apollo.disconnect()remove a chave. As chamadas seguintes voltam a usar a conta da Clickmax.
Buscar pessoas
- Os filtros aceitos são
q_keywords,q_organization_name,q_organization_keyword_tags,organization_locations,organization_num_employees_ranges,organization_ids,organization_domains,person_titles,person_titles_current_only,person_seniorities,person_locations,contact_email_statusecurrently_using_any_of_technology_uids. Outros campos são ignorados sem erro. per_pagevai até 100. A paginação vem emdata.paginationou emdata.total_entries, como a Apollo devolver.- Para listar quem trabalha numa empresa, envie o
idda empresa emorganization_ids. - A busca não é cobrada. Ela não traz e-mail, telefone nem o sobrenome completo (vem em
last_name_obfuscated). Para isso, passe oidde cada pessoa parapeopleMatch.
Identificar uma pessoa
Envie um destes: id, email, linkedin_url, ou um nome (first_name + last_name, ou name) junto com domain ou organization_name. Sem nenhum deles, a chamada volta com erro invalid_input antes de chegar à Apollo.
Confira data.person.match_confidence para saber se a Apollo encontrou a pessoa:
high,mediumoulowindicam que a Apollo achou alguém, com mais ou menos certeza.none, oudata.person: null, indica que a pessoa não foi encontrada. Mesmo assim, a resposta é de sucesso, edata.personpode vir preenchido só com o e-mail enviado e a empresa do domínio desse e-mail, emdata.person.organization.
A identificação só é cobrada quando encontra a pessoa. Com match_confidence: none, nada é cobrado.
Telefones e o waterfall de e-mail não são pedidos: a Apollo só entrega esses dados depois, por webhook.
Buscar a empresa pelo domínio
Quando a Apollo não conhece o domínio, a resposta é de sucesso com data.organization: null, e nada é cobrado.
Descobrir o domínio pelo nome da empresa
Cada página é cobrada, mesmo quando vem vazia.
Tempo limite
Todas as chamadas que consultam a Apollo aceitam timeout, de 1000 a 60000 milissegundos, com padrão de 30000. Mantenha o timeout do cliente da Clickmax (padrão de 60000) acima do timeout da chamada, para receber a resposta da Apollo em vez de um erro de tempo do SDK.
Erros da Apollo
Leia o code do erro para decidir o que fazer.
Ao conectar, uma chave recusada volta com status 422 e não é guardada.
A Clickmax não repete chamadas à Apollo por conta própria. Os limites de chamadas da API da Clickmax continuam valendo.