Bem-vindo à documentação da API!
Esta API oferece suporte para operações em diferentes sistemas integrados, incluindo os módulos de Inventário, Anúncios, Autenticação, Leads e outros. Aqui você encontrará informações detalhadas sobre os endpoints disponíveis, parâmetros de entrada, exemplos de requisições e respostas, facilitando a integração e o uso das funcionalidades oferecidas.
Obtém os detalhes de um veículo específico pelo ID.
\nid (obrigatório): Identificador único do veículo.
getReport)Este método recupera relatórios detalhados para um anunciante específico com base nos parâmetros fornecidos.
\nadvertiser_id (string): ID do anunciante.
report_type (string): Tipo de relatório (ex.: BASIC).
dimensions (array): Dimensões para o agrupamento dos dados (ex.: adgroup_id).
data_level (string): Nível dos dados (ex.: AUCTION_ADGROUP).
start_date (string): Data de início no formato YYYY-MM-DD.
end_date (string): Data de término no formato YYYY-MM-DD.
metrics (array): Métricas a serem incluídas no relatório.
Requisição:
\nuse TikTokAds\\Report\\ReportManager;\n$reportManager = new ReportManager(\"SEU_TOKEN_DE_ACESSO\");\n$params = [\n 'advertiser_id' => '0000000000000000000',\n 'report_type' => 'BASIC',\n 'dimensions' => ['adgroup_id'],\n 'data_level' => 'AUCTION_ADGROUP',\n 'start_date' => '2024-12-01',\n 'end_date' => '2024-12-30',\n 'metrics' => [\n \"campaign_id\", \"campaign_name\", \"impressions\", \"clicks\", \"conversion\", \n \"budget\", \"spend\", \"onsite_form\", \"onsite_shopping\", \n \"onsite_initiate_checkout_count\", \"onsite_on_web_cart\", \"onsite_add_billing\"\n ]\n];\n$response = $reportManager->getReport($params);\nprint_r($response);\n\nResposta:
\n{\n \"code\": 0,\n \"message\": \"OK\",\n \"request_id\": \"2025012214454248D365647\",\n \"data\": {\n \"list\": [\n {\n \"metrics\": {\n \"conversion\": 5,\n \"spend\": 652.96,\n \"impressions\": 76804,\n \"clicks\": 9477,\n \"campaign_id\": \"00000000000000\",\n \"campaign_name\": \"Leadfy - TikTok\",\n \"onsite_on_web_cart\": 0,\n \"onsite_form\": 0,\n \"onsite_shopping\": 0,\n \"budget\": 35,\n \"onsite_initiate_checkout_count\": 0,\n \"onsite_add_billing\": 0\n },\n \"dimensions\": {\n \"adgroup_id\": \"000000000000\"\n }\n }\n ],\n \"page_info\": {\n \"total_number\": 1,\n \"total_page\": 1,\n \"page_size\": 1,\n \"page\": 1\n }\n }\n}\n\ngetInfo)Este método recupera informações básicas sobre um anunciante, como o saldo.
\nadvertiser_ids (array): Array contendo o(s) ID(s) do(s) anunciante(s).
fields (array): Campos que devem ser retornados (ex.: balance).
Requisição:
\nuse TikTokAds\\Advertiser\\Advertiser;\n$advertiser = new Advertiser(\"SEU_TOKEN_DE_ACESSO\");\n$params = [\n 'advertiser_ids' => json_encode(['000000000000000000']),\n 'fields' => json_encode([\"balance\"])\n];\n$response = $advertiser->getInfo($params);\nprint_r($response);\n\nResposta:
\n{\n \"code\": 0,\n \"message\": \"OK\",\n \"request_id\": \"2025012214174179D49B0CE47F3\",\n \"data\": {\n \"list\": [\n {\n \"balance\": 1000.0\n }\n ]\n }\n}\n\nCria um novo lead no sistema. Este endpoint processa dados de leads vindos de webhooks ou formulários.
\n","urlObject":{"protocol":"https","path":["api","webhook","leads","store"],"host":["leads","leadfy","me","test"],"query":[],"variable":[]}},"response":[{"id":"28a5d209-1e37-4756-aa06-feb7392264c9","name":"Sucesso - Lead Criado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"leadfyUser\": \"user123\",\n \"phone\": \"11999999999\",\n \"email\": \"lead@example.com\",\n \"name\": \"João Silva\",\n \"store_id\": \"store_001\",\n \"event_name\": \"page_view\"\n}"},"url":"https://leads.leadfy.me/api/webhook/leads/store"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Lead criado com sucesso!\",\n \"leadfyUId\": 123\n}"},{"id":"867af57d-02ce-41ae-8008-f6a7667c4dcc","name":"Erro - Dados Inválidos","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"leadfyUser\": \"user123\",\n \"store_id\": \"store_001\",\n \"event_name\": \"page_view\"\n}"},"url":"https://leads.leadfy.me/api/webhook/leads/store"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Erro ao criar lead: No value for phone or email.\"\n}"}],"_postman_id":"82a07dcc-d150-4fab-9d78-a239b9eedf41"}],"id":"a1746596-2b4e-43f4-bd52-f681ccd1e221","description":"Coleção de endpoints da API Leadfy para gerenciamento de leads
\n","_postman_id":"a1746596-2b4e-43f4-bd52-f681ccd1e221"}],"event":[{"listen":"prerequest","script":{"id":"ab92df3b-56a7-4993-8aa1-f26659765658","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"02b3fbf2-c4b0-4442-a11f-409d0111ba13","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"value":"","type":"string","disabled":true}]}