Expose Drupal 8 user operations as routes that support the JSON exchange format.
- A configurable path that provides User Login, Register, Password Reset, and Account form handlers.
- Post-process hooks for customizing JSON response data on request success.
- Support for
application/jsonContent-Type for POST requests and related responses. - Easy integration into AngularJS, EmberJS, or jQuery applications - No custom headers or tokens required.
- Download the latest release.
- Extract the contents of the .zip into:
<drupal root>/modules/contrib/
Once the module has been installed/enabled, you can navigate to admin/config/services/headless (Configuration > Web Services > Headless in the Admin panel) to configure the publicly accessible Routing Path.
- CORS (Optional, but recommended)
The FormState instance is returned that includes the form_id and field values. In cases where this in NOT preferred you can override the response data prior to sending.
function hook_headless_response_alter(array &$data) {
// Preprocess Login responses.
if ($data['form_id'] == 'user_login_form') {
// Return nothing.
$data = NULL;
}
}
When using custom field parameter names in your client-side application you can alter these values prior to FormState validation.
function hook_headless_request_alter(array &$params) {
// Preprocess request parameters.
if (isset($params['name'])) {
// Add prefix to key name.
$params['field_name'] = $params['name'];
unset($params['name']);
}
}
Using the AngularJS $http service.
$http({
method: 'POST',
url: '/headless/user/login',
cache: false,
data: {
name: '<name>',
pass: '<pass>'
},
withCredentials: true
})
.then(
function successCallback(response) {},
// handle errors
function errorCallback(response) {
if (response.status === 400) {}
if (response.status === 500) {}
}
);
Using the jQuery $ajax method.
$.ajax({
type: 'POST',
url: '/headless/user/login',
dataType: 'json',
data: {
name: '<name>',
pass: '<pass>'
},
cache: false,
statusCode: {
// login success
202: function(data) {},
// handle errors
400: function() {},
500: function() {}
},
xhrFields: {
withCredentials: true
}
});
Using the AngularJS $http service.
$http({
method: 'POST',
url: '/headless/user/register',
cache: false,
data: {
mail: '<mail>',
name: '<name>',
pass: '<pass>'
}
})
.then(
function successCallback(response) {},
// handle errors
function errorCallback(response) {
if (response.status === 400) {}
if (response.status === 500) {}
}
);
Using the jQuery $ajax method.
$.ajax({
type: 'POST',
url: '/headless/user/register',
dataType: 'json',
data: {
mail: '<mail>',
name: '<name>',
pass: '<pass>'
},
cache: false,
statusCode: {
// login success
202: function(data) {},
// handle errors
400: function() {},
500: function() {}
}
});
If you fix a bug, or have a code you want to contribute, please send a pull-request with your changes. (Note: Before committing your code please ensure that you are following the Drupal coding standards)
You can check your code by running the following command:
$ phpcs --standard=./vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml src
This package is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.
headless is provided under the terms of the MIT license
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent