Eksportér (0) Udskriv
Udvid alt
EN
Dette indhold er ikke tilgængeligt på dit sprog, men her er den engelske version.

Setup for Media Services REST API Development

Updated: February 18, 2014

Microsoft Azure Media Services is a service that accepts OData-based HTTP requests and can respond back in verbose JSON or atom+pub. Because Media Services conforms to Azure design guidelines, there is a set of required HTTP headers that each client must use when connecting to Media Services, as well as a set of optional headers that can be used. The following sections describe the headers and HTTP verbs you can use when creating requests and receiving responses from Media Services.

After you have a basic understanding of how to construct your requests, see Connecting to Media Services with the Media Services REST API for information on access tokens and the Media Services URI.

Standard HTTP request headers supported by Media Services

For every call you make into Media Services, there is a set of required headers you must include in your request and also a set of optional headers you may want to include. The following table lists the required headers:

 

Header Type Value

Authorization

Bearer

Bearer is the only accepted authorization mechanism. The value must also include the access token provided by ACS.

x-ms-version

Decimal

2.5

DataServiceVersion

Decimal

3.0

MaxDataServiceVersion

Decimal

3.0

noteNote
Because Media Services uses OData to expose its underlying asset metadata repository through REST APIs, the DataServiceVersion and MaxDataServiceVersion headers should be included in any request; however, if they are not, then currently Media Services assumes the DataServiceVersion value in use is 3.0.

The following is a set of optional headers:

 

Header Type Value

Date

RFC 1123 date

Timestamp of the request

Accept

Content type

The requested content type for the response such as the following:

  • application/json;odata=verbose

  • application/atom+xml

noteNote
Responses may have a different content type, such as a blob fetch, where a successful response will contain the blob stream as the payload.

Accept-Encoding

Gzip, deflate

GZIP and DEFLATE encoding, when applicable. Note: For large resources, Media Services may ignore this header and return noncompressed data.

Accept-Language

"en", "es", and so on.

Specifies the preferred language for the response.

Accept-Charset

Charset type like “UTF-8”

Default is UTF-8.

X-HTTP-Method

HTTP Method

Allows clients or firewalls that do not support HTTP methods like PUT or DELETE to use these methods, tunneled via a GET call.

Content-Type

Content type

Content type of the request body in PUT or POST requests.

client-request-id

String

A caller-defined value that identifies the given request. If specified, this value will be included in the response message as a way to map the request.

ImportantImportant
Values should be capped at 2096b (2k).

Standard HTTP response headers supported by Media Services

The following is a set of headers that may be returned to you depending on the resource you were requesting and the action you intended to perform.

 

Header Type Value

request-id

String

A unique identifier for the current operation, service generated.

client-request-id

String

An identifier specified by the caller in the original request, if present.

Date

RFC 1123 date

The date that the request was processed.

Content-Type

Varies

The content type of the response body.

Content-Encoding

Varies

Gzip or deflate, as appropriate.

Standard HTTP verbs supported by Media Services

The following is a complete list of HTTP verbs that can be used when making HTTP requests:

 

Verb Description

GET

Returns the current value of an object.

POST

Creates an object based on the data provided, or submits a command.

PUT

Replaces an object, or creates a named object (when applicable).

DELETE

Deletes an object.

MERGE

Updates an existing object with named property changes.

HEAD

Returns metadata of an object for a GET response.

See Also


Build Date:

2014-07-11

Fællesskabsindhold

Tilføj
Vis:
© 2014 Microsoft