You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/rest_api_authentication.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -353,7 +353,7 @@ you can get the JWT token through the following request:
353
353
354
354
## HTTP basic authentication
355
355
356
-
For more information, see [HTTP Authentication: Basic and Digest Access Authentication](http://tools.ietf.org/html/rfc2617).
356
+
For more information, see [HTTP Authentication: Basic and Digest Access Authentication](https://datatracker.ietf.org/doc/html/rfc2617).
357
357
358
358
### Configuration
359
359
@@ -381,7 +381,7 @@ If the installation has a dedicated host for REST, you can enable HTTP basic aut
381
381
### Usage example
382
382
383
383
Basic authentication requires the username and password to be sent *(username:password)*, base64 encoded, with each request.
384
-
For details, see [RFC 2617](http://tools.ietf.org/html/rfc2617).
384
+
For details, see [RFC 2617](https://datatracker.ietf.org/doc/html/rfc2617).
385
385
386
386
Most HTTP client libraries as well as REST libraries support this method.
387
387
[Creating content with binary attachments](rest_api_requests.md#creating-content-with-binary-attachments) has an example using basic authentication with [cURL](https://www.php.net/manual/en/book.curl.php) and its `CURLOPT_USERPWD`.
|[OPTIONS](https://datatracker.ietf.org/doc/html/rfc2616#section-9.2)| Standard | List available methods | Yes |
26
+
|[GET](https://datatracker.ietf.org/doc/html/rfc2616#section-9.3)| Standard | Collect data | Yes |
27
+
|[HEAD](https://datatracker.ietf.org/doc/html/rfc2616#section-9.4)| Standard | Check existence | Yes |
28
+
|[POST](https://datatracker.ietf.org/doc/html/rfc2616#section-9.5)| Standard | Create an item | No |
29
+
|[PATCH](https://datatracker.ietf.org/doc/html/rfc5789)| Custom | Update an item | No |
30
+
| COPY | Custom | Duplicate an item | No |
31
+
|[MOVE](https://datatracker.ietf.org/doc/html/rfc2518)| Custom | Move an item | No |
32
+
| SWAP | Custom | Swap two Locations | No |
33
+
| PUBLISH | Custom | Publish an item | No |
34
+
|[DELETE](https://datatracker.ietf.org/doc/html/rfc2616#section-9.7)| Standard | Remove an item | No |
35
35
36
36
!!! note "Caution with custom HTTP methods"
37
37
@@ -47,7 +47,7 @@ Unsafe methods will require a CSRF token if [session-based authentication](rest_
47
47
48
48
Any URI resource that the REST API responds to will respond to an `OPTIONS` request.
49
49
50
-
The response contains an [`Allow` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.7), which lists the methods accepted by the resource.
50
+
The response contains an [`Allow` header](https://www.rfc-editor.org/rfc/rfc9110.html#name-allow), which lists the methods accepted by the resource.
You can use the following HTTP headers with a REST request:
83
83
84
-
-[`Accept`](https://tools.ietf.org/html/rfc2616#section-14.1) describing the desired response type and format;
85
-
-[`Content-Type`](https://toos.ietf.org/html/rfc2616#section-14.17) describing the payload type and format;
84
+
-[`Accept`](https://datatracker.ietf.org/doc/html/rfc2616#section-14.1) describing the desired response type and format;
85
+
-[`Content-Type`](https://datatracker.ietf.org/doc/html/rfc2616#section-14.17) describing the payload type and format;
86
86
-[`X-Siteaccess`](#siteaccess) specifying the target SiteAccess;
87
87
-`X-HTTP-Method-Override` allowing to pass a custom method while using `POST` method as previously seen in [HTTP method](#request-method).
88
88
-[`Destination`](#destination) specifying where to move an item
@@ -114,8 +114,8 @@ On top of methods, HTTP request headers allow you to personalize the request's b
114
114
On every resource, you can use the `Accept` header to indicate which format you want to communicate in, JSON or XML.
115
115
This header is also used to specify the response type you want the server to send when multiple types are available.
116
116
117
-
-`Accept: application/vnd.ez.api.Content+xml` to get `Content` (full data, Fields included) as **[XML](http://www.w3.org/XML/)**
118
-
-`Accept: application/vnd.ez.api.ContentInfo+json` to get `ContentInfo` (metadata only) as **[JSON](http://www.json.org/)**
117
+
-`Accept: application/vnd.ez.api.Content+xml` to get `Content` (full data, Fields included) as **[XML](https://www.w3.org/XML/)**
118
+
-`Accept: application/vnd.ez.api.ContentInfo+json` to get `ContentInfo` (metadata only) as **[JSON](https://www.json.org/)**
119
119
120
120
Media types are also used with the [`Content-Type` header](rest_api_responses.md#content-type-header) to characterize a [request body](#request-body) or a [response body](rest_api_responses.md#response-body).
121
121
See [Creating content with binary attachments](#creating-content-with-binary-attachments) below.
@@ -142,11 +142,11 @@ You can pass some short scalar parameters in the URIs or as GET parameters, but
142
142
in particular the ones to create (`POST`) or update (`PATCH`) items.
143
143
In the [REST API reference](rest_api_reference/rest_api_reference.html), request payload examples are given when needed.
144
144
145
-
One example is the [creation of an authentication session](rest_api_authentication.md#establishing-a-session).
145
+
One example is the [creation of an authentication session](rest_api_authentication.md#establishing-session).
146
146
147
147
When creating a Content item, a special payload is needed if the ContentType has some [Image](field_types_reference/imagefield.md) or [BinaryFile](field_types_reference/binaryfilefield.md) Fields as files need to be attached. See the example of a [script uploading images](#creating-content-with-binary-attachments) below.
148
148
149
-
When searching for Content items (or Locations), the query grammar is also particular. See the [Search section](#search-view) below.
149
+
When searching for Content items (or Locations), the query grammar is also particular. See the [Search section](#search-views) below.
@@ -258,7 +258,7 @@ Error messages can change, do not use them for automated processing.
258
258
259
259
In most cases the recommendation engine's response can be cached.
260
260
Depending on the recommendation model and context, it can drastically reduce the number of recommendation requests.
261
-
The recommendation service supports the following HTTP headers to enable cache control on the client side (all date values must follow the "HTTP-date" format as defined by [RFC 2616](https://tools.ietf.org/html/rfc2616)):
261
+
The recommendation service supports the following HTTP headers to enable cache control on the client side (all date values must follow the "HTTP-date" format as defined by [RFC 2616](https://datatracker.ietf.org/doc/html/rfc2616)):
0 commit comments