Este tópico mostra as etapas de como autenticar e usar uma API de relatórios financeiros para obter os demonstrativos financeiros da ID da conta RAMP/Acadia vinculada à sua conta do Slate. Se ainda tiver dúvidas após seguir essas etapas, entre em contato com seu gerenciador do fornecedor ou crie um tíquete por meio do Suporte Fale conosco.
Pré-requisito
É necessário ter uma conta do Prime Video Slate para realizar essas etapas.
- Se você ainda não tem uma conta do Slate, acesse slate.amazon.com e crie uma conta. Depois, volte para esta página e comece da Etapa 1.
OU - Se já passou pelo processo de integração em relatórios legados existentes de Canais e TVOD por meio da API, vá para a Etapa 3.
Etapa 1: Obter código de usuário do Slate
Para obter seu código de usuário do Slate, consulte o guia de permissões de usuário e acesso.
Etapa 2: Obter autorização para acessar a API de relatórios
Para integrar seu aplicativo à API de relatórios financeiros, você deve primeiro se cadastrar no pacote de API Analytics. Para obter instruções detalhadas sobre integração, acesse a página de Integração da API.
Para obter mais detalhes sobre como trabalhar com APIs, consulte APIs do Prime Video.
Etapa 4: Criar a URL correta da API
O URL geral da API de relatórios tem o seguinte formato, em que o conteúdo entre colchetes{} varia de acordo com o parceiro:https://videocentral.amazon.com/apis/v1/accounts/{account_id}/financialStatement/{report_identifier}/reportTypes/{report_type_id}/reports
Cada parâmetro do caminho de espaço reservado é definido abaixo.
- account_id: ID da conta RAMP/Acadia que está vinculada à sua conta do Slate. Peça essa ID ao seu gerente de parceiros. Se você já usa o sistema de relatórios antigo, essa configuração permanecerá inalterada.
report_identifier: Isso é configurado pelo seu gerente de parceiros ou gerenciador do fornecedor. Para obter uma lista dos relatórios disponíveis para sua conta, acesse a URL da API https://videocentral.amazon.com/apis/v1/accounts/{account_id}/financialStatement
Essa ação mostrará todos os identificadores de relatório aos quais você tem acesso.
report_type_id: Isso é um valor fixo. Use uma das seguintes opções para recuperar relatórios
- Para Canais: amzn1.vcpa.arcs.insight.286fd5d9-aeb3-4eb0-99a1-959225160a01
- Para TVOD: amzn1.vcpa.arcs.insight.33ee837f-af47-40d6-8c2c-798eba24fac8
- Para taxa fixa de SVOD: amzn1.vcpa.arcs.insight.10a37dcd-8912-4173-b428-600e237f7508
- Para AVOD, SVOD CPH e Linear: amzn1.vcpa.arcs.insight.f9efc58e-51dd-4e2c-a864-aae7e32a7f73
Resposta final da API
Quando você tiver a URL correta da API e seu gerente de parceiros tiver apresentado os relatórios certos para você, essa é a resposta resultante da API. (A captura de tela a seguir é da URL da API de uma conta de teste.)
A URL da API usada para obter relatórios deve ser:
https://videocentral.amazon.com/apis/v1/accounts/{partner’s acadia account ID}/financialStatement/{report_identifier}/reportTypes/{report_type_id}/reports
O downloadUrl mostrado na resposta da API é uma URL pré-assinada que permite baixar o relatório. O modifiedDate mostrado na resposta da API é o momento em que os dados foram atualizados em um relatório específico.
A URL da API fornecerá todos os relatórios disponíveis para sua conta do Slate. Para analisar meses específicos, você pode usar os parâmetros de solicitação da API reportDateBeginGte e reportDateBeginLt para especificar o intervalo de tempo.
Para obter, por exemplo, relatórios específicos de outubro de 2024, defina o reportDateBeginGte como 01/10/2024 e o reportDateBeginLt como 01/11/2024.
Para obter mais informações sobre outras APIs de relatórios, consulte APIs do Prime Video.
