Visão geral da referência da API api-reference-overview

A API de monitoramento de simultaneidade fornece uma interface RESTful para gerenciar sessões de transmissão e aplicar políticas de uso simultâneas. Esta referência fornece documentação completa para todos os endpoints, métodos de autenticação, formatos de solicitação/resposta e manipulação de erros.

URLs de base da API

Ambiente de produção

https://streams.adobeprimetime.com/v2/

Ambiente de preparo

https://streams-stage.adobeprimetime.com/v2/

Observação: sempre use o ambiente de preparo para desenvolvimento e teste. As credenciais de produção são fornecidas somente após a integração de preparo bem-sucedida.

Autenticação

Todas as chamadas de API exigem Autenticação Básica HTTP usando suas credenciais de aplicativo:

Exemplo de cabeçalho de autenticação

curl -u "<your-app-id>:" https://streams-stage.adobeprimetime.com/v2/sessions

For an application with id "demo-app" the authentication header would be exactly as shown below, including the quotes and colon:
curl -u "demo-app:" https://streams-stage.adobeprimetime.com/v2/sessions

Padrões de Formato de Resposta

Respostas de sucesso

Todas as respostas bem-sucedidas seguem esta estrutura:

{
  "status": "success",
  "data": {
    // Response-specific data
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Respostas de erro

Todas as respostas de erro seguem esta estrutura:

{
  "associatedAdvice": [
    {
      "policyName": "string",
      "ruleName": "string",
      "scope": {},
      "attribute": "string",
      "threshold": 0,
      "conflicts": [
        {}
      ]
    }
  ],
  "obligations": [
    {
      "namespace": "string",
      "action": "string",
      "arguments": [
        "string"
      ]
    }
  ]
}

Formato do resultado da avaliação

Quando as políticas são avaliadas (especialmente para conflitos 409), as respostas incluem um resultado de avaliação:

{
  "evaluationResult": {
    "decision": "DENY",
    "obligations": [
      {
        "id": "obligation-id",
        "fulfillOn": "DENY",
        "attributes": {
          "attribute1": "value1"
        }
      }
    ],
    "associatedAdvice": [
      {
        "id": "advice-id",
        "adviceType": "rule-violation",
        "attributes": {
          "rule": "rule-name",
          "threshold": 3,
          "current": 4,
          "conflicts": [
            {
              "sessionId": "session-123",
              "terminationCode": "term-456",
              "metadata": {
                "deviceId": "device-789",
                "channel": "Channel1"
              }
            }
          ]
        }
      }
    ]
  }
}

Códigos de status HTTP comuns

Métodos de envio de parâmetros

Parâmetros de caminho

Parâmetros obrigatórios que fazem parte do caminho do URL:

Parâmetros adicionais

Parâmetros opcionais são passados no URL:

GET /sessions/{idp}/{subject}?platform=test

Dados de formulário (POST/PUT)

Metadados e dados de sessão no corpo da solicitação:

POST /sessions/{idp}/{subject}
Content-Type: application/x-www-form-urlencoded

channel=Channel1&deviceId=device-123&contentType=live

Cabeçalhos

Parâmetros especiais passados em cabeçalhos HTTP:

X-Terminate: termination-code-123
X-Client-Version: 1.0.0

Práticas recomendadas de tratamento de erros

409 Tratamento de conflitos

Quando você receber uma resposta de Conflito 409:

410 Manuseio perdido

Ao receber uma resposta 410 Gone:

Limite de taxa

Ao receber 429 muitas solicitações:

Ferramentas de teste

API Explorer interativo

Use nossa Interface do usuário do Swagger para testes interativos: