Pular para o conteúdo principal
Neste guia você cria um pré-teste de mídia exterior (OOH) e baixa o PDF. Os valores dos exemplos são fictícios.
A chave de API é um segredo de servidor. Guarde-a em uma variável de ambiente do seu back-end. Nunca a coloque em código de navegador, em app de celular ou em repositório.

1. Crie a chave no painel

  1. Entre no painel da Unite com uma conta de administrador do workspace.
  2. Abra a área de administração do workspace e vá em Chaves de API.
  3. Clique em Criar chave.
  4. Dê um nome (por exemplo, “Integração do CRM”), escolha as permissões Ler pré-testes e Criar pré-testes e defina a validade.
  5. Clique em Criar chave e copie o valor. Ele aparece uma única vez.
Se a tela avisar que a API ainda não está liberada para o workspace, fale com o time da Unite. Nos exemplos abaixo, a chave fica na variável UNITE_API_KEY. O valor tem o formato unite_live_SUA_CHAVE_AQUI.
Os blocos de cada linguagem formam um só roteiro: você pode colar os passos 2 a 7 em um único arquivo, na ordem. No curl, cada passo guarda em variáveis do shell os valores que o próximo usa (precisa do jq). Os exemplos de JavaScript usam node 18 ou mais novo, em módulo ES (.mjs). O catálogo lista os formatos OOH, as plataformas digitais e as marcas do workspace. Guarde o key do formato que você vai usar.

3. Peça o endereço de envio

Informe o tipo e o tamanho do arquivo. A resposta traz o uploadId e uma URL de envio válida por 15 minutos.
Resposta (valores fictícios; o uploadUrl real é longo e muda a cada pedido):

4. Envie o arquivo

Faça um PUT do arquivo na uploadUrl, com todos os cabeçalhos devolvidos, exatamente com os mesmos valores. Esta chamada não leva a chave de API. Veja os detalhes em Envio de arquivos.

5. Crie o pré-teste

Envie o uploadId e o canal. O cabeçalho Idempotency-Key é obrigatório: use um valor novo por pré-teste e reutilize-o só para repetir a mesma chamada. Veja Idempotência.
A resposta é 202 e traz o cabeçalho Location com o endereço do pré-teste.

6. Consulte até completed

Consulte a cada 10 segundos ou mais. Com completed, o campo result traz nota, pilares e achados (veja Resultados). Com failed, o campo error.code diz o motivo. Se terminar em failed, pare aqui: não há PDF para baixar.

7. Baixe o PDF

O PDF é gerado sob demanda. Se ainda estiver sendo gerado, a resposta é 202 com Retry-After: espere esse número de segundos e tente de novo. Com 200 e status: "ready", baixe o arquivo em url. Essa segunda chamada é um GET simples na url, sem a chave de API.
Busque o link quando precisar do arquivo e não conte com a URL continuar a mesma: peça o PDF de novo em vez de guardar o link.

Próximos passos