Habilitar acesso aos serviços Web OData

Concluído

Com os serviços Web OData, você pode acessar dados do Business Central em outros aplicativos usando REST. Esses serviços Web OData são usados frequentemente em relatórios de Power BI para recuperar dados do Business Central. Os serviços Web OData são habilitados prontos para uso, a fim de que você possa iniciar imediatamente.

Para obter uma lista de todos os serviços Web OData disponíveis ou para criar um novo serviço Web, procure serviços Web na caixa de pesquisa.

  1. Selecione o ícone pesquisar no canto superior direito.

  2. Insira serviços Web na caixa de pesquisa Diga-me o que você quer fazer.

  3. Selecione Serviços Web na lista exibida.

Captura de tela dos resultados da pesquisa Diga-me para serviços Web.

A página que exibe os serviços Web disponíveis é usada para habilitar o acesso aos serviços Web OData e SOAP. Os serviços Web no Business Central são baseados em objetos existentes, como páginas, consultas e codeunits.

Um serviço Web OData só pode ser usado com os tipos de objeto Page e Query, juntamente com codeunits por meio de ações não associadas OData. Cada objeto publicado gerará um link que você pode usar para acessar o serviço Web. São fornecidos links para o OData versão 4 e o serviço Web SOAP. Para obter mais informações, consulte a seção Serviços Web OData.

Para adicionar um novo serviço Web OData, selecione o botão Novo no menu e, em seguida, selecione o Tipo de Objeto. Para OData, você pode escolher Page ou Query. Selecione a ID do Objeto e dê um nome ao serviço. No exemplo a seguir, o objeto Customer Card é usado para expor os registros do cliente como um serviço Web OData, que é chamado Clientes. Por fim, marque a caixa de seleção Publicado. Depois que você selecionar o botão Recarregar no menu, o Business Central gerará um link OData v4.

Captura de tela do objeto Customer Card usado para expor registros como serviço Web OData com a caixa de seleção publicada.

O link que foi gerado sempre segue a mesma estrutura.

https://api.businesscentral.dynamics.com/v2.0/<tenant\>/ODataV4/<service\>

No ambiente de área restrita, você pode usar a seguinte estrutura.

https://api.businesscentral.dynamics.com/v2.0/<tenant\>/sandbox/ODataV4/<service\>