API-referens - översikt api-reference-overview

API:t för övervakning av samtidig användning (Concurrency Monitoring) innehåller ett RESTful-gränssnitt för hantering av direktuppspelningssessioner och genomförande av principer för samtidig användning. Den här referensen innehåller fullständig dokumentation för alla slutpunkter, autentiseringsmetoder, fråge-/svarsformat och felhantering.

API-bas-URL

Produktionsmiljö

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

Mellanlagringsmiljö

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

Obs! Använd alltid mellanlagringsmiljön för utveckling och testning. Produktionsautentiseringsuppgifter anges först efter lyckad integration i testversionerna.

Autentisering

Alla API-anrop kräver HTTP Basic Authentication med dina programautentiseringsuppgifter:

Exempel på autentiseringsrubrik

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

Standarder för svarsformat

Slutförda svar

Alla lyckade svar följer den här strukturen:

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

Felsvar

Alla felsvar följer den här strukturen:

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

Utvärderingsresultatformat

När profiler utvärderas (särskilt för 409 konflikter) innehåller svaren ett utvärderingsresultat:

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

Vanliga HTTP-statuskoder

Metoder för parameteröverföring

Sökvägsparametrar

Obligatoriska parametrar som är en del av URL-sökvägen:

Ytterligare parametrar

Valfria parametrar skickas i URL

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

Formulärdata (POST/PUT)

Metadata och sessionsdata i begärandetexten:

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

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

Sidhuvuden

Specialparametrar som skickas i HTTP-rubriker:

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

Felhantering av bästa praxis

409 Konflikthantering

När du får ett 409-konfliktsvar:

410 Borttagning

När du får ett svar på 410 Gone:

Hastighetsbegränsning

När du får 429 för många begäranden:

Testverktyg

Interaktiv API Explorer

Använd vårt Swagger-gränssnitt för interaktiv testning: