Proteção da reprodução - Base de conhecimento

Drm

Por projeto

Obter autenticação

GET {{baseHost}}/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  }}

{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}

{  "error": {    "code": 404404,    "message": "no such entity"  }}

{
  "error": {
    "code": 404404,
    "message": "no such entity"
  }
}

curl -X GET \  '{{baseHost}}/v1/drm/auth/:project_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/drm/auth/:project_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Atualizar autenticação

PUT {{baseHost}}/v1/drm/auth/:project_id

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

Campo	Tipo	Descrição
url	string	Endpoint de autenticação
username	string	Usuário do endpoint de autenticação
password	string	Senha
strict	bool	Modo estrito.
Se true, a licença DRM é entregue quando `url` responde com o código HTTP 200.
Se false, a licença DRM é entregue para qualquer código HTTP, exceto 403.

Request body (json)

{  "url": "https://example.io/auth/kinescope",  "username": "",  "password": "",  "strict": false}

{
  "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  }}

{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}

curl -X PUT \  '{{baseHost}}/v1/drm/auth/:project_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "url": "https://example.io/auth/kinescope",  "username": "",  "password": "",  "strict": false}'

curl -X PUT \
  '{{baseHost}}/v1/drm/auth/:project_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.io/auth/kinescope",
  "username": "",
  "password": "",
  "strict": false
}'

Excluir autenticação

DELETE {{baseHost}}/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  }}

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

curl -X DELETE \  '{{baseHost}}/v1/drm/auth/:project_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X DELETE \
  '{{baseHost}}/v1/drm/auth/:project_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Obter autenticação

GET {{baseHost}}/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  }}

{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}

{  "error": {    "code": 404404,    "message": "no such entity"  }}

{
  "error": {
    "code": 404404,
    "message": "no such entity"
  }
}

Atualizar autenticação

PUT {{baseHost}}/v1/drm/auth

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

Campo	Tipo	Descrição
url	string	Endpoint de autenticação
username	string	Usuário do endpoint de autenticação
password	string	Senha
strict	bool	Modo estrito.
Se true, a licença DRM é entregue quando `url` responde com o código HTTP 200.
Se false, a licença DRM é entregue para qualquer código HTTP, exceto 403.

Request body (json)

{  "url": "https://example.io/auth/kinescope",  "username": "",  "password": "",  "strict": true}

{
  "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  }}

{
  "data": {
    "url": "https://example.io/auth/kinescope",
    "username": "",
    "password": "",
    "created_at": "2021-11-10T10:33:43.359069Z",
    "updated_at": null
  }
}

curl -X PUT \  '{{baseHost}}/v1/drm/auth' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "url": "https://example.io/auth/kinescope",  "username": "",  "password": "",  "strict": true}'

curl -X PUT \
  '{{baseHost}}/v1/drm/auth' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.io/auth/kinescope",
  "username": "",
  "password": "",
  "strict": true
}'

Excluir autenticação

DELETE {{baseHost}}/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  }}

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

Privacy domains

Obter domínios

GET {{baseHost}}/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": "Igor",      "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": "Igor",      "created_at": "2021-10-09T17:34:03.51782Z",      "updated_at": null,      "archived_at": null,      "media_count": 0    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "domain": "www.the-village.ru",      "created_by_user_name": "Igor",      "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": "Igor",      "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": "vc.ru",      "created_by_user_name": "Igor",      "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": "Igor",      "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": "Igor",      "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": "Igor",      "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": "Igor",      "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": "Igor",      "created_at": "2022-06-06T19:33:22.540944Z",      "updated_at": null,      "archived_at": null,      "media_count": 2    }  ]}

{
  "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": "Igor",
      "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": "Igor",
      "created_at": "2021-10-09T17:34:03.51782Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 0
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "domain": "www.the-village.ru",
      "created_by_user_name": "Igor",
      "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": "Igor",
      "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": "vc.ru",
      "created_by_user_name": "Igor",
      "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": "Igor",
      "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": "Igor",
      "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": "Igor",
      "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": "Igor",
      "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": "Igor",
      "created_at": "2022-06-06T19:33:22.540944Z",
      "updated_at": null,
      "archived_at": null,
      "media_count": 2
    }
  ]
}

Criar domínio

POST {{baseHost}}/v1/privacy-domains

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

Request body (json)

{  "domain": "test.ru"}

{
  "domain": "test.ru"
}

curl -X POST \  '{{baseHost}}/v1/privacy-domains' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "domain": "test.ru"}'

curl -X POST \
  '{{baseHost}}/v1/privacy-domains' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain": "test.ru"
}'

Atualizar domínio

PUT {{baseHost}}/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}

{
  "domain": "test.ru",
  "archived": true
}

curl -X PUT \  '{{baseHost}}/v1/privacy-domains/:domain_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "domain": "test.ru",  "archived": true}'

curl -X PUT \
  '{{baseHost}}/v1/privacy-domains/:domain_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain": "test.ru",
  "archived": true
}'

Excluir domínio

DELETE {{baseHost}}/v1/privacy-domains/:domain_id

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

Request body (json)

{  "domain": "test.ru",  "archived": true}

{
  "domain": "test.ru",
  "archived": true
}

curl -X DELETE \  '{{baseHost}}/v1/privacy-domains/:domain_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "domain": "test.ru",  "archived": true}'

curl -X DELETE \
  '{{baseHost}}/v1/privacy-domains/:domain_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain": "test.ru",
  "archived": true
}'