...
A seguir será demonstrado um exemplo de medição, mas antes devemos acessar e autenticar no Swagger, para saber mais sobre procedimento de autenticação, clique no link "Gerando Token e autenticando no Swagger".
Devemos seguir os seguintes passos:
- Ter realizado os procedimentos dos pré requisitos mencionado acima;
- Localizar a subscrição que será realizado o procedimento de medição;
- Publicar o ajuste conforme modelo de payload disponibilizado na documentação do Swagger.
Passo 2. Com o Id armazenado no momento da Subscrição, utilize o mesmo para realizar a pesquisa no GET do endpoint SubscriptinUsage.
Image Added
Response disponibilizado na execução do Swagger. Armazene as informações pois elas serão utilizadas na publicação da medição.
Image Added
Passo 3. No POST do endpoint SubscripionUsage, realize o preenchimento do payload conforme documentação do Swagger.
Image Added
| Dica |
|---|
| title | Preenchimento do Payload |
|---|
|
{
"subscriptionId": "284bed4b-5a75-43d8-9a68-9b6a7d313180", -→ Id gerado pela Subscrição.
"subscriptionItemId": "284bed4b-5a75-43d8-9a68-9b6a7d313180", -→ Item da Subscrição.
"itemIntegrationId": "T1|D MG 01|011001", -→ Integration ID do Item.
"itemId": "284bed4b-5a75-43d8-9a68-9b6a7d313180", -→ ID do Item armazenado no momento da criação do item.
"usageDate": "2023-02-01", -→ Data deve pertence ao período da cobrança. Caso seja diferente, uma mensagem de erro será apresentada.
"quantity": 10.5, -→ Valor da medição Abaixo são preenchimentos para o range de metadata e integrações com o Protheus. "metadata": [
{
"alias": "string",
"name": "string",
"key": "string",
"value": "string"
}
],
"integrationId": "284bed4b-5a75-43d8-9a68-9b6a7d313180",
"source": "Nome da Rotina",
"origin": "Protheus"
} |
Response quando executado com sucesso.
...
Image Added
| Nota |
|---|
|
A medição será calculo após execução do JobScheduller, quando percorrer o período da agenda realizada pelo administrador do sistema. Maiores informações sobre o JobScheduller clique aqui. |
...
