iGRPIGRP 3.0Documentation

Configuração e administração

Definições da aplicação, RGPD e retenção.

Obter definições da aplicação

GET
/api/v1/settings

Permissão: igrp.notification.admin. Canais, remetentes, quotas, domínios de callback e retenção.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
applicationCode?string
allowedChannels?array<>
senders?array<>
defaultPreferredOrder?array<>
quotas?array<>
allowedCallbackDomains?array<string>
defaultCallbackUrl?string
retention?
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/settings'
{  "applicationCode": "string",  "allowedChannels": [    "EMAIL"  ],  "senders": [    {      "channel": "EMAIL",      "identifier": "string",      "displayName": "string",      "defaultSender": true    }  ],  "defaultPreferredOrder": [    "EMAIL"  ],  "quotas": [    {      "channel": "EMAIL",      "limit": 0,      "period": "HOUR"    }  ],  "allowedCallbackDomains": [    "string"  ],  "defaultCallbackUrl": "string",  "retention": {    "defaultRetention": "string",    "categories": {      "property1": "string",      "property2": "string"    }  }}

Atualizar definições da aplicação

PUT
/api/v1/settings

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Corpo do pedido

application/json
  1. body
allowedChannels?array<>
senders?array<>
defaultPreferredOrder?array<>
quotas?array<>
allowedCallbackDomains?array<string>
defaultCallbackUrl?string
retention?
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
applicationCode?string
allowedChannels?array<>
senders?array<>
defaultPreferredOrder?array<>
quotas?array<>
allowedCallbackDomains?array<string>
defaultCallbackUrl?string
retention?
curl -X PUT 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/settings' \  -H 'Content-Type: application/json' \  -d '{}'
{  "applicationCode": "string",  "allowedChannels": [    "EMAIL"  ],  "senders": [    {      "channel": "EMAIL",      "identifier": "string",      "displayName": "string",      "defaultSender": true    }  ],  "defaultPreferredOrder": [    "EMAIL"  ],  "quotas": [    {      "channel": "EMAIL",      "limit": 0,      "period": "HOUR"    }  ],  "allowedCallbackDomains": [    "string"  ],  "defaultCallbackUrl": "string",  "retention": {    "defaultRetention": "string",    "categories": {      "property1": "string",      "property2": "string"    }  }}

Anonimizar utilizador (RGPD)

POST
/api/v1/admin/recipients/{userId}/forget

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

userId*string

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
[key: string]?unknown
curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/admin/recipients/string/forget'
{  "property1": null,  "property2": null}

Apagar dados fora da retenção

POST
/api/v1/admin/retention/purge

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
[key: string]?unknown
curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/admin/retention/purge'
{  "property1": null,  "property2": null}
How is this guide?

Última atualização: