API Documentation

Appearance

Applications Resource ​

Description ​

The Applications resource allows you to manage the applications of your Xvid MediaHub account.

An application represents a set of alternate API credentials (client_id / client_secret) that let you delegate API access under your account to one or more external systems — e.g. a signing script, your website, or a mobile app - without exposing your actual account username and password. Key properties of applications:

  • Delegated access: Each application carries its own client_id/client_secret pair and its own set of API scopes, so you can grant a script or site exactly the permissions it needs (e.g. only mediahub_read, or additionally mediahub_write).
  • Revocable / regenerable: You can update or delete an application at any time (e.g. to rotate credentials when an app got compromised) without affecting your overall account or your other applications.
  • Per-application usage tracking: Because every API call is associated with the application that authenticated it, your account usage (e.g. conversion, storage and bandwidth) can be tracked individually per application - useful when you run several sites under one account.
  • Custom CNAME: An application can be assigned a custom cname to map the MediaHub API under your own domain (see the custom-domain tutorial).
  • Anti-fraud configuration: Applications that use the AutoGraph anti-fraud feature carry an antifraud_settings configuration (callback URL, thresholds, extended auth / 2FA email template, etc.).

Each application is identified by its id and is identical to its client_id. This same value is used in all endpoints that target a specific application (GET/PUT/DELETE /applications/{id}).

Endpoints ​

  • GET /applications/: List all applications of your account (or get a specific one by its id).
  • POST /applications/: Create a new application.
  • PUT /applications/{id}: Update an existing application.
  • DELETE /applications/{id}: Delete an application.

Authentication ​

All endpoints require a Bearer token:

  • GET requires the mediahub_read scope.
  • POST, PUT, DELETE require the mediahub_write scope.

Supported Methods ​

  • GET: Retrieve information about applications.
  • POST: Create a new application.
  • PUT: Update an existing application.
  • DELETE: Delete an application.

Request Headers ​

  • Authorization: Bearer [AUTH_TOKEN]
  • Content-Type: application/json (for POST and PUT requests)

Common Parameters ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Request Accept header.
  • human: boolean (Optional)
    Values: true, false
    If 'true', the response will be in a structured, more human-readable form.
  • show_null: boolean (Optional)
    Values: true, false
    If set to "true", the response will contain also keys that are not set to a value.

Notes ​

  • There is a maximum of 100 applications per account.
  • The cname value, if provided, must be a valid sub-domain of your own site's domain (and unique per application).
  • The scopes you request on create/update must be a subset of the scopes granted to your account by your subscription.

For detailed information about each method, please refer to the respective documentation files: GET.md, POST.md, PUT.md and DELETE.md.