Referência
As rotas internas são o contrato do navegador. As chamadas TikTok são feitas pelo backend, com Access-Token, e estão aqui para explicar o que cada etapa da interface provoca.
Duas camadas, um token
O navegador chama rotas do próprio HYDR com a sua sessão. O backend resolve a conexão autorizada e chama a API TikTok com o Access-Token. O token não é entregue ao JavaScript público, e o corpo da resposta TikTok também precisa ser validado: sucesso de transporte não substitui code = 0.
Rotas internas do HYDR
Sessão, autorização, CSRF, proprietário e IDs de tarefa fazem parte do contrato
| Rota | Papel | Observação |
|---|---|---|
| /api/workspace/connect e /disconnect | Iniciar ou remover conexão do usuário | — |
| /api/tiktok/callback | Receber retorno OAuth e concluir a tentativa | — |
| /api/workspace/connections | Ler conexões e BCs; atualização explícita quando solicitada | Resposta antiga não deve ressuscitar conexão removida. |
| /api/workspace/catalog-create | Iniciar e consultar criação isolada de catálogo | Usa Idempotency-Key com escopo de proprietário. |
| /api/workspace/launch-jobs | Iniciar lançamento e listar histórico e progresso | — |
| /api/workspace/launch-jobs/ID | Consultar o job autorizado pelo proprietário | — |
| /api/workspace/launch-options | Carregar país, moeda, idioma e demais opções | Interseção de amostra de até 5 contas. |
| /api/workspace/launch-account-countries | Consultar países de segmentação por conta | Lotes de até 20 contas. Diferente do país do catálogo. |
| /api/workspace/launch-smart-options | Carregar identidade, música e CTA Smart+ | — |
| /api/workspace/launch-pixels | Consultar pixels disponíveis para uma conta | — |
| /api/workspace/catalog-eligibility | Iniciar e consultar scan de elegíveis | — |
| /api/workspace/catalog-products | Gestão e remoção de produtos conforme autorização | — |
| /api/workspace/catalogs | Exclusão de catálogo pelo método apropriado | Exige Admin confirmado e bloqueia catálogo em operação. |
| /api/workspace/upload/sign | Obter capacidade temporária para upload de objeto | — |
| /api/workspace/upload/thumb | Preparar miniatura | — |
| /api/workspace/identity-image | Enviar e normalizar avatar por conta | — |
| /api/workspace/display-card-image | Preparar imagem de complemento | — |
| /api/tiktok/launch/feed | Compatibilidade interna: gerar feed | — |
| /api/feedfile | Compatibilidade de leitura protegida do feed | Exige autorização própria. |
Endpoints inventariados
38
Extraídos do código
Mutações (POST)
17
Criam ou alteram recursos
Etapas
21
Rotas internas
19
O que o front conhece
Chamadas à API TikTok
https://business-api.tiktok.com/open_api/v1.3
| Método | Endpoint | Etapa | Por quê | Quando | Onde no código |
|---|---|---|---|---|---|
| POST | /ad/create/ | Clássico | Cria anúncio com identidade, catálogo, texto, CTA e tracking. | Depende de adgroup_id. |
|
| /ad/get/ | Estado | Lê estado após criação; consulta complementar. | Falha nessa leitura não desfaz criação já confirmada. |
| |
| POST | /adgroup/create/ | Clássico | Cria grupo com público, catálogo, pixel, agenda e lance. | Depende de campaign_id. |
|
| /adgroup/get/ | Gestão | Consulta grupos e configurações. | Leitura antes de alterações e gestão. |
| |
| POST | /adgroup/update/ | Gestão | Altera configuração de grupo existente. | Manutenção; não etapa necessária de toda criação. |
|
| /advertiser/info/ | Contas | Lê nome, estado, moeda, fuso e BC das contas. | Descoberta em lotes e conferência de estado. |
| |
| /bc/asset/get/ | Permissões | Consulta ativos e papéis da BC; confirma vínculo/Admin. | Fallback de descoberta, catálogos e exclusão. |
| |
| /bc/balance/get/ | Gestão | Consulta saldo da BC no fluxo de gestão. | Não explica sozinho entrega ou elegibilidade. |
| |
| /bc/get/ | Descoberta | Lista BCs acessíveis e ajuda a recuperar o vínculo proprietário. | Conexões e recuperação de autorização de catálogo. |
| |
| POST | /campaign/create/ | Clássico | Cria campanha com objetivo e orçamento. | Depois de catálogo pronto. |
|
| /campaign/get/ | Gestão | Consulta campanhas e metadados. | Ads Manager/diagnóstico; não reimporta produtos. |
| |
| POST | /campaign/status/update/ | Gestão | Altera estado operacional de campanhas. | Ação explícita de gestão. |
|
| /catalog/available_country/get/ | Opções | Lê países de catálogo permitidos para a BC. | Não substitui os países de segmentação da conta. |
| |
| POST | /catalog/create/ | Catálogo | Cria ativo ECOM da BC com região/moeda. | Somente caminho de catálogo novo. |
|
| POST | /catalog/delete/ | Manutenção | Exclui catálogo remoto após conferir Admin e operações ativas. | Pedido explícito de exclusão. |
|
| /catalog/feed/get/ | Compatibilidade | Consulta feeds vinculados ao catálogo. | Diagnóstico/rota de compatibilidade; não cria agendamento. |
| |
| /catalog/get/ | Catálogo | Lê dados e disponibilidade publicitária do catálogo. | Biblioteca, validação e polling após importação. |
| |
| /catalog/location_currency/get/ | Opções | Lê combinações região/moeda para catálogo. | Criação e pré-carregamento. |
| |
| POST | /catalog/product/delete/ | Manutenção | Exclui produtos selecionados e sincroniza inventário. | Manutenção protegida; não faz parte de consulta de status. |
|
| POST | /catalog/product/file/ | Importação | Solicita importação imediata do lote por file_url. | Novo catálogo; exige recibo feed_log_id. |
|
| /catalog/product/get/ | Produtos | Lê total, SKUs, revisão e elegibilidade individuais. | Validação, detalhes e scans internos/externos. |
| |
| /catalog/product/log/ | Importação | Lê estado/contagens da importação recebida. | Polling, sem repetir uma importação confirmada. |
| |
| /creative/cta/recommend/ | Smart+ | Consulta opções de CTA compatíveis. | Pré-validação de identidade/CTA. |
| |
| POST | /creative/portfolio/create/ | Criativo | Cria portfólio de CTA ou complemento interativo. | Condicional ao formato e complemento. |
|
| POST | /event/track/ | Conversões | Envia eventos pela integração de pixel/CAPI quando configurada. | Fluxo de eventos, não publicação de produtos. |
|
| POST multipart | /file/image/ad/upload/ | Imagem | Envia imagem de identidade/complemento e recebe identificador. | Não é upload dos vídeos de produtos do catálogo. |
|
| /file/music/get/ | Smart+ | Pesquisa música compatível com carrossel de catálogo. | Somente quando o formato requer. |
| |
| POST | /identity/create/ | Identidade | Cria identidade personalizada para a conta. | Fluxo clássico, quando necessário. |
|
| /identity/get/ | Identidade | Lê identidades disponíveis e seus tipos. | Reuso clássico e seleção Smart+. |
| |
| POST | /oauth2/access_token/ | Conexão | Troca o código OAuth pelo token no backend. | Somente no callback autorizado. |
|
| /oauth2/advertiser/get/ | Conexão | Atualiza a lista de anunciantes realmente autorizados pelo token. | Discovery/atualização com cache e assinatura da conexão. |
| |
| /pixel/list/ | Pixel | Lista pixels disponíveis para a conta. | Seleção de evento de conversão; não cria compras. |
| |
| /report/integrated/get/ | Métricas | Lê métricas publicitárias em períodos/dimensões. | Dashboard e Ads Manager; distinto de eventos IPN. |
| |
| POST | /smart_plus/ad/create/ | Smart+ | Cria anúncio/carrossel de catálogo Smart+. | Exige identidade, música, CTA e destino. |
|
| POST | /smart_plus/adgroup/create/ | Smart+ | Cria grupo Smart+ com targeting_spec. | Mesma condição, sem fallback silencioso de estratégia. |
|
| POST | /smart_plus/campaign/create/ | Smart+ | Cria campanha com payload da família Upgraded Smart+. | CBO + CPA nesta versão. |
|
| /tool/language/ | Segmentação | Obtém códigos de idioma aceitos pela API. | Opções de público. |
| |
| /tool/region/ | Segmentação | Lê destinos de campanha para anunciante/objetivo/placement. | Lançador e filtro por países. |
|
O inventário não é captura de tráfego
A lista vem de literais dos módulos consultados. Não prova que todas as chamadas aconteçam em todo lançamento, e rotas montadas dinamicamente ou scripts fora desses módulos não aparecem automaticamente. A presença de uma operação na documentação oficial também não significa que o HYDR a use.