A Subscrição baseada em números de conta da Visibilidade integrada avançada foi criada para os subscritores da Visibilidade integrada avançada gerirem os respetivos projetos de Visibilidade integrada avançada baseados em números de conta e efetuarem operações relacionadas com projetos, como editar ou ver detalhes de tarefas com pontos finais da API.

Nota:

• Tem de ter acesso de administrador ao seu projeto da API onde esta API estiver ativada.
• Para obter mais informações sobre a Visibilidade integrada avançada e as respetivas funcionalidades, aceda à página da documentação da Visibilidade integrada avançada.

As vantagens da Subscrição baseada em números de conta da Visibilidade integrada avançada são:

• Pode atualizar e gerir facilmente o seu projeto de Visibilidade integrada avançada com os pontos finais da API.
• Esta API permite-lhe associar várias contas ao projeto numa única transação de API, em vez de ter de selecionar cada conta separadamente.

Utilize os pontos finais abaixo para gerir o projeto de Visibilidade integrada avançada:

Atualizar o Projeto de Visibilidade integrada avançada

Utilize este ponto final para atualizar os detalhes do projeto de Visibilidade integrada avançada da sua organização.

As informações de introdução deste pedido são:

• requestType: especifique o tipo de pedido de atualização. 
  • ADD_ACCOUNTS: utilize esta opção para adicionar novas contas ao projeto existente se a organização já estiver associada ao projeto de Visibilidade integrada avançada para todas as contas.
  • DELETE_ACCOUNTS: utilize esta opção para eliminar uma conta do projeto.
  • UPDATE_ALL: utilize esta opção para atualizações regulares do projeto.
Nota: trata-se de um elemento opcional e UPDATE_ALL está selecionado por predefinição, se não for especificado pelo utilizador.
• category: especifique a categoria da funcionalidade do projeto que pretende atualizar. Exemplo: RETRY_POLICY, PROOF_OF_DELIVERY, etc.
• subCategories: especifique as funcionalidades individuais da categoria de funcionalidade selecionada. Exemplo: BASIC_HRS, PPOD, SPOD, SHIP, TRAN, etc.

A resposta bem-sucedida a este pedido irá devolver a ID de subscrição, um indicador se o projeto foi atualizado em todas as contas na organização, e um registo de data/hora do projeto atualizado.

Obter detalhes do projeto

Utilize este ponto final para obter os detalhes do projeto, de um projeto de Visibilidade integrada avançada especificado, num formato paginado.

As informações de introdução obrigatória deste pedido são:

• authorization: especifique o token de autorização.
• subscriptionId: especifique a ID de subscrição do projeto de Visibilidade integrada avançada para obter os detalhes.

A resposta bem-sucedida a este pedido irá gerar os detalhes do projeto de webhook especificado num formato paginado ou irá devolver os detalhes de alerta ou erro em caso de falhas.

• Podem ser associados, no máximo, 30 000 números de conta de expedição a um projeto de Visibilidade integrada avançada em cada pedido.