Pular navegação
Base de conhecimento

Proteção da reprodução

DRM e domínios permitidos.

Drm

Obter autenticação

GET https://api.kinescope.io/v1/drm/auth

Retorna a configuração de autenticação de DRM (URL, cabeçalhos) usada hoje nas requisições de licença.

Responses
{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}
{
  "error": {
    "code": 400404,
    "message": "not found"
  }
}

Atualizar autenticação

PUT https://api.kinescope.io/v1/drm/auth

Atualiza a configuração de autenticação de licença DRM.

CampoTipoDescrição
urlstringEndpoint de autenticação. O Kinescope envia a ele uma solicitação POST com corpo JSON (id, ip, type, token, user_agent) a cada solicitação de licença DRM, sem novas tentativas.
usernamestringUsuário do endpoint de autenticação. Se definido, as solicitações para url levam o cabeçalho Authorization: Basic com username e password; se não definido, o cabeçalho não é enviado.
passwordstringSenha
strictboolModo estrito. true: a licença DRM é emitida apenas quando url responde com HTTP 200; qualquer outro código, a falta de resposta em 5 segundos ou a indisponibilidade de url bloqueiam a reprodução. false: apenas HTTP 403 bloqueia a reprodução; qualquer outro código, a falta de resposta em 5 segundos ou a indisponibilidade de url não impedem a reprodução. O corpo da resposta é ignorado.
Request body (json)
{
  "url": "https://example.io/auth/kinescope",
  "username": "",
  "password": "",
  "strict": true
}
Responses
{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}

Excluir autenticação

DELETE https://api.kinescope.io/v1/drm/auth

Remove a configuração de autenticação de licença DRM. É preciso configurar o DRM de novo antes de usar.

Responses
{
  "data": {
    "success": true
  }
}

Por projeto

Obter autenticação

GET https://api.kinescope.io/v1/drm/auth/:project_id

Retorna a configuração de autenticação de DRM (URL, cabeçalhos) usada hoje nas requisições de licença.

Responses
{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}
{
  "error": {
    "code": 400404,
    "message": "not found"
  }
}

Atualizar autenticação

PUT https://api.kinescope.io/v1/drm/auth/:project_id

Atualiza a configuração de autenticação de licença DRM.

CampoTipoDescrição
urlstringEndpoint de autenticação. O Kinescope envia a ele uma solicitação POST com corpo JSON (id, ip, type, token, user_agent) a cada solicitação de licença DRM, sem novas tentativas.
usernamestringUsuário do endpoint de autenticação. Se definido, as solicitações para url levam o cabeçalho Authorization: Basic com username e password; se não definido, o cabeçalho não é enviado.
passwordstringSenha
strictboolModo estrito. true: a licença DRM é emitida apenas quando url responde com HTTP 200; qualquer outro código, a falta de resposta em 5 segundos ou a indisponibilidade de url bloqueiam a reprodução. false: apenas HTTP 403 bloqueia a reprodução; qualquer outro código, a falta de resposta em 5 segundos ou a indisponibilidade de url não impedem a reprodução. O corpo da resposta é ignorado.
Request body (json)
{
  "url": "https://example.io/auth/kinescope",
  "username": "",
  "password": "",
  "strict": false
}
Responses
{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}

Excluir autenticação

DELETE https://api.kinescope.io/v1/drm/auth/:project_id

Remove a configuração de autenticação de licença DRM. É preciso configurar o DRM de novo antes de usar.

Responses
{
  "data": {
    "success": true
  }
}

Privacy domains

Criar domínio

POST https://api.kinescope.io/v1/privacy-domains

Cria um domínio de privacidade. Em caso de sucesso, retorna o objeto criado.

Request body (json)
{
  "domain": "test.ru"
}

Obter domínios

GET https://api.kinescope.io/v1/privacy-domains

Retorna a lista de domínios de privacidade. Os resultados são paginados e podem ser filtrados por parâmetros de consulta.

Responses
{
  "meta": {
    "offset": 0,
    "limit": 10,
    "total": 22,
    "total_count": 0,
    "order": {
      "created_at": "asc"
    },
    "parent_id": null
  },
  "data": [
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "edbyte.ru",
      "created_by_user_name": "Example User",
      "created_at": "2021-08-09T08:56:36.632808Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "newwwww",
      "created_by_user_name": "Example User",
      "created_at": "2021-10-09T17:34:03.51782Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "www.example.com",
      "created_by_user_name": "Example User",
      "created_at": "2021-11-23T15:38:15.360147Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "example-shop.com",
      "created_by_user_name": "Example User",
      "created_at": "2021-12-30T10:59:19.447503Z",
      "updated_at": "2022-03-23T10:55:36.938605Z",
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "blog.example.com",
      "created_by_user_name": "Example User",
      "created_at": "2021-12-30T11:03:22.627174Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "kinescope.io",
      "created_by_user_name": "Example User",
      "created_at": "2022-05-02T13:13:09.277207Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 1
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "iframely.com",
      "created_by_user_name": "Example User",
      "created_at": "2022-05-02T13:27:50.013863Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "antitreningi.ru",
      "created_by_user_name": "Example User",
      "created_at": "2022-05-02T13:27:50.013863Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 3
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "*.iframely.com",
      "created_by_user_name": "Example User",
      "created_at": "2022-05-02T13:29:54.470445Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 1
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "druzh.ru",
      "created_by_user_name": "Example User",
      "created_at": "2022-06-06T19:33:22.540944Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 2
    }
  ]
}

Atualizar domínio

PUT https://api.kinescope.io/v1/privacy-domains/:domain_id

Atualiza o domínio de privacidade indicado. Só os campos enviados no corpo da requisição são alterados; os demais ficam como estão.

Request body (json)
{
  "domain": "test.ru",
  "archived": true
}

Excluir domínio

DELETE https://api.kinescope.io/v1/privacy-domains/:domain_id

Exclui o domínio de privacidade permanentemente. A ação não pode ser desfeita.