Política de Limitação

O conjunto de endpoints a seguir são destinados ao gerenciamento de políticas de limitação de acesso ao DICT, permitindo consultar as políticas aplicadas e o status dos baldes de tokens do participante.

Listar políticas

Endpoint para obter a lista de políticas de limitação de acesso ao DICT para o participante requisitante.

Além da lista de políticas, o serviço informa também a categoria em que o participante se encontra, de acordo com a tabela presente no item ENTRIES_READ_PARTICIPANT_ANTISCAN da seção limitação de requisições.

Cada item da lista detém informações do estado do balde correspondente no momento da consulta.

GET /dict/policies

Requer autorização para o escopo:

Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth, parâmetros e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
  "category": "A",
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "policies": [
    {
      "availableTokens": 100,
      "capacity": 1000,
      "name": "ENTRIES_READ_PARTICIPANT_ANTISCAN",
      "refillPeriodSec": 3600,
      "refillTokens": 100
    }
  ],
  "responseTime": 150
}

🔴 401

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not authenticated",
    "status": 401,
    "title": "Unauthorized"
  },
  "responseTime": 50
}

🔴 403

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not allowed to access this resource",
    "status": 403,
    "title": "Forbidden"
  },
  "responseTime": 50
}

🔴 500

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  },
  "responseTime": 200
}

🔴 503

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  },
  "responseTime": 100
}

Consultar política

Endpoint para consultar uma política de limitação.

GET /dict/policies/:policy

Requer autorização para o escopo:

Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth, parâmetros e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
  "Category": "A",
  "Policy": {
    "AvailableTokens": 100,
    "Capacity": 1000,
    "Name": "ENTRIES_READ_PARTICIPANT_ANTISCAN",
    "RefillPeriodSec": 3600,
    "RefillTokens": 100
  },
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "responseTime": 120
}

🔴 401

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not authenticated",
    "status": 401,
    "title": "Unauthorized"
  },
  "responseTime": 50
}

🔴 500

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  },
  "responseTime": 200
}

🔴 503

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  },
  "responseTime": 100
}