Panoramica dei riferimenti API api-reference-overview

L’API di monitoraggio della concorrenza fornisce un’interfaccia RESTful per gestire le sessioni di streaming e applicare i criteri di utilizzo simultanei. Questa guida fornisce una documentazione completa per tutti gli endpoint, i metodi di autenticazione, i formati di richiesta/risposta e la gestione degli errori.

URL di base API

Ambiente di produzione

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

Ambiente di staging

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

Nota: utilizza sempre l'ambiente di gestione temporanea per lo sviluppo e il testing. Le credenziali di produzione vengono fornite solo dopo l’integrazione della gestione temporanea.

Autenticazione

Tutte le chiamate API richiedono l’autenticazione HTTP Basic utilizzando le credenziali dell’applicazione:

Esempio di intestazione di autenticazione

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

Standard del formato di risposta

Risposte di successo

Tutte le risposte di successo seguono questa struttura:

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

Risposte di errore

Tutte le risposte di errore seguono questa struttura:

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

Formato risultati valutazione

Quando vengono valutati i criteri (in particolare per i conflitti 409), le risposte includono un risultato di valutazione:

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

Codici di stato HTTP comuni

Metodi di passaggio dei parametri

Parametri percorso

Parametri obbligatori che fanno parte del percorso URL:

Parametri aggiuntivi

I parametri facoltativi vengono passati nell’URL:

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

Dati modulo (POST/PUT)

Metadati e dati della sessione nel corpo della richiesta:

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

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

Intestazioni

Parametri speciali trasmessi nelle intestazioni HTTP:

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

Best practice per la gestione degli errori

Gestione dei conflitti 409

Quando ricevi una risposta di conflitto 409:

410 Gone Handling

Quando si riceve una risposta 410 Gone:

Limitazione di tariffa

Quando si riceve un 429 Troppe richieste:

Strumenti di test

API Explorer interattiva

Utilizza la nostra interfaccia utente Swagger per i test interattivi: