adidas API design guidelines

The POST method requests that the server accept the entity enclosed in the request as a new subordinate of the web resource identified by the URI. The data POSTed might be, for example, an annotation for existing resources; a message for a bulletin board, newsgroup, mailing list, or comment thread; a block of data that is the result of submitting a web form to a data-handling process; or an item to add to a database.

Query Requests with Large Inputs

HTTP methods

General information about HTTP methods usage

Request Methods

HTTP Protocol

Caching

How to use and provide relevant caching informations

Caching

Content negociation and media types

How to describe your API data format and/or propose different formats (like json, yaml, xml atom, …)

Content Negociation

HTTP Headers

How to use standard or custom HTTP headers

Naming Conventions
Every HTTP Header should use Hyphenated-Pascal-Case. A custom HTTP Header SHOULD NOT start with X- (RFC6648).

HTTP Statuses

General information about HTTP statuses usage

HTTP protocol

General informations about HTTP protocol

HTTP

HTTP Status Redirection

303 See Other

The response to the request can be found under another URI using a GET method. When received in response to a POST (or PUT/DELETE), the client should presume that the server has received the data and should issue a redirect with a separate GET message.

Asynchronous Tasks

HTTP Status Success

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

HTTP Status User Error

400 Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, too large size, invalid request message framing, or deceptive request routing).

Security

401 Unauthorized

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource.

Security

403 Forbidden

The request was a valid request, but the server is refusing to respond to it. The user might be logged in but does not have the necessary permissions for the resource.

Security

404 Not Found

The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.

Security

405 Method Not Allowed

A request method is not supported for the requested resource; for example, a GET request on a form which requires data to be presented via POST, or a PUT request on a read-only resource.