Tutorial: Trabalhar com registros de dados de poços usando APIs do Well Delivery DDMS
Use as APIs do Well Delivery Domain Data Management Services (DDMS) no Postman para trabalhar com dados de poço em sua instância do Gerenciador de Dados de Energia do Azure.
Neste tutorial, você aprenderá a:
- Configure o Postman para usar uma coleção de Well Delivery DDMS.
- Configure o Postman para usar um ambiente Well Delivery DDMS.
- Enviar solicitações por meio do Postman.
- Gerar um token de autorização.
- Use as APIs do Well Delivery DDMS para trabalhar com registros de dados de poços.
Para obter mais informações sobre DDMS, consulte os conceitos de DDMS.
Pré-requisitos
- Uma assinatura do Azure
- Uma instância do Gerenciador de Dados de Energia do Azure criada na sua assinatura do Azure
Obter os detalhes da instância do Gerenciador de Dados de Energia do Azure
A primeira etapa é obter as seguintes informações da instância do Gerenciador de Dados de Energia do Azure no portal do Azure:
Parâmetro | Valor | Exemplo |
---|---|---|
CLIENT_ID |
ID do aplicativo (cliente) | 00001111-aaaa-2222-bbbb-3333cccc4444 |
CLIENT_SECRET |
Segredos do cliente | _fl****************** |
TENANT_ID |
ID do diretório (locatário) | 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx |
SCOPE |
ID do aplicativo (cliente) | 00001111-aaaa-2222-bbbb-3333cccc4444 |
base_uri |
URI | <instance>.energy.azure.com |
data-partition-id |
Partições de dados | <instance>-<data-partition-name> |
Você usará essa informação mais adiante neste tutorial.
Configurar o Postman
Baixe e instale o aplicativo da área de trabalho Postman.
Importe os seguintes arquivos para o Postman:
Para importar os arquivos:
No ambiente Postman, atualize CURRENT VALUE com as informações da sua instância do Gerenciador de Dados de Energia do Azure:
No Postman, no menu à esquerda, selecione Ambientes e, em seguida, selecione Ambiente WellDelivery.
Na coluna CURRENT VALUE, insira as informações da tabela na seção Obter detalhes da instância do Gerenciador de Dados de Energia do Azure deste tutorial.
Enviar uma solicitação do Postman
A coleção do Postman para Well Delivery DDMS contém solicitações que você pode usar para interagir com dados sobre poços, boca de poços, logs de poços e trajetória de poços na instância do Gerenciador de Dados de Energia do Azure.
Para obter um exemplo de como enviar uma solicitação do Postman, consulte o tutorial do Wellbore DDMS.
Gerar um token para APIs
Gere um token que você pode usar para trabalhar com APIs Well Delivery DDMS:
Importe o comando cURL a seguir no Postman para gerar um token de portador. Use os valores da instância do Azure Data Manager for Energy.
curl --location --request POST 'https://login.microsoftonline.com/{{TENANT_ID}}/oauth2/v2.0/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'client_id={{CLIENT_ID}}' \ --data-urlencode 'client_secret={{CLIENT_SECRET}}' \ --data-urlencode 'scope={{SCOPE}}'
Use a saída do token para atualizar
access_token
no ambiente do Well Delivery DDMS. Em seguida, você pode usar o token de portador como um tipo de autorização em outras chamadas à API.
Use as APIs do Well Delivery DDMS para trabalhar com registros de dados de poços
A conclusão com êxito das solicitações do Postman descritas nas seguintes APIs do Well Delivery DDMS indica a ingestão bem-sucedida e a recuperação de registros de poços na instância do Gerenciador de Dados de Energia do Azure.
Criar um registro de poço
Crie um registro de poço na instância de versão prévia do Azure Data Manager for Energy.
API: UC1>entity_create well
Método: PUT
Criar um registro da boca do poço
Crie um registro da boca do poço na instância do Gerenciador de Dados do Azure para Energia.
API: UC1>entity_create wellbore
Método: PUT
Obter uma versão de poço
Obtenha um registro de poço com base em uma ID de poço específica.
API: UC1>entity_create well Copy
Método: GET
Criar um plano de atividade
Criar um plano de atividade.
API: UC1>entity_create activityplan
Método: PUT
Obter um plano de atividade por ID de poço
Obter o objeto do plano de atividades para um ID de poço específico.
API: UC2>activity_plans_by_well
Método: GET
Excluir um registro de poço
Você pode excluir um registro de perfuração de poço na sua instância do Gerenciador de Dados de Energia do Azure usando APIs do Well Delivery DDMS. A captura de tela a seguir mostra um exemplo.
Excluir um registro de poço
Você pode excluir um registro de poço na sua instância do Gerenciador de Dados de Energia do Azure usando APIs do Well Delivery DDMS. A captura de tela a seguir mostra um exemplo.
Próximas etapas
Vá para o próximo tutorial para saber como trabalhar com dados do poço usando as APIs do Wellbore DDMS: