Listar Bitlinks no Bitly, por uma API

Lista os Bitlinks de um grupo, com id, link, long_url, título e tags. A resposta tem links e pagination: passe pagination.search_after como search_after, com os mesmos filtros, para ler a próxima página.

Identificador
bitly_list_bitlinks

A chamada

POST https://connect.reportei.com/api/tools/bitly_list_bitlinks/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "group_guid": "<group_guid>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
group_guidstringSimGuid of the group, from List groups.
querystringNãoText to search for in the links of the group.
tagsarrayNãoOnly the links with these tags.
archivedstringNãoon lists only archived links, off only the active ones and both lists all. The default is off.Valores: on, off, both
created_afterintegerNãoOnly links created after this moment, as a Unix timestamp in seconds.
created_beforeintegerNãoOnly links created before this moment, as a Unix timestamp in seconds.
sizeintegerNãoLinks per page. The default is 50.
search_afterstringNãoThe pagination.search_after of the previous response.

Conexões possíveis

O seu cliente conecta a conta do Bitly uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/bitly, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/bitly_list_bitlinks. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Bitly

Ver as 11 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.