Nagłówki żądania

W niniejszej dokumentacji przykłady poleceń są zapisywane z wykorzystaniem HTTPie (opens new window).

Nagłówek 'x-auth-token'

Nagłówek x-auth-token przeznaczony jest do uwierzytelniania żądania do Platformy.

Nagłówek 'x-project'

Każdy Użytkownik może mieć dostęp do wielu Projektów. Z tego powodu w przypadku wykorzystania identyfikatora sesji Użytkownika w celu modyfikowania Zasobów Projektu należy wskazać Projekt, którego dotyczy żądanie w nagłówku x-project w następujący sposób:

$ http -v GET https://api.hyperone.com/v1/image x-auth-token:5beab306913f2d5d821b350c x-project:5bec28a99e1716681aeb6164
GET /v1/image HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: api.hyperone.com
User-Agent: HTTPie/0.9.2
x-auth-token: 5beab306913f2d5d821b350c
x-project: 5bec28a99e1716681aeb6164


HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=utf-8
Date: Wed, 14 Nov 2018 17:11:33 GMT
ETag: W/"44f-mgg0+kIQ0OS8BLkO3tYRK5S/C/Y"
Referrer-Policy: strict-origin-when-cross-origin
Server: nginx
Set-Cookie: x-auth-token=5beab306913f2d5d821b350c; Path=/; Expires=Wed, 14 Nov 2018 18:11:06 GMT; HttpOnly; Secure
Strict-Transport-Security: max-age=31536000; includeSubdomains; preload
Transfer-Encoding: chunked
Vary: Accept-Encoding
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-XSS-Protection: 1; mode=block

[
    ...
]

Nagłówek 'Prefer'

Część operacji API może być czasochłonna. W takim przypadku Platforma może wykonać żądanie asynchronicznie poprzez odpowiedź z statusem 202 oraz z nagłówkiem x-event-id zawierający identyfikator operacji. Asynchroniczne wykonanie jest kontrolowane - zgodnie z RFC7240 (opens new window) - poprzez nagłówek Prefer.

W celu uzyskania natychmiastowej odpowiedzi bez względu na rzeczywisty czas wykonania operacji należy przesłać w nagłówku żądania:

Prefer: respond-async,wait=0

W celu oczekiwania na wykonanie operacji przez określony czas należy przesłać w nagłówku żądania:

Prefer: respond-async,wait=86400

Wartość86400 stanowi maksymalny czas oczekiwania w sekundach.