# Varbase API

A JSON:API implementation with authentication and authorization that allows for easy ingestion of content by other applications.

## Varbase API Module

{% hint style="info" %}
Varbase API features are bundled through the **Varbase API** module.\
GitHub: <https://github.com/Vardot/varbase_api>\
Drupal.org: <https://www.drupal.org/project/varbase_api>

After building a project using the `varbase-project` template, you can see the code of the **Varbase API** module in:
{% endhint %}

```
project_directory
|-- docroot
    |-- modules
        |-- contrib
            |-- varbase_api
```

Brings in the following core and contributed modules to your site:

| Module                                                                                    | Purpose                                                         |
| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| <p><strong>JSON:API</strong></p><p><em>(in Drupal core)</em></p>                          | Exposes entities as a JSON:API-specification-compliant web API. |
| [**Consumers**](https://www.drupal.org/project/consumers)                                 | Declare all the consumers of your API.                          |
| [**OpenAPI**](https://www.drupal.org/project/openapi)                                     | Connects Drupal to the OpenAPI Javascript Library.              |
| [**OpenAPI for JSON:API**](https://www.drupal.org/project/openapi_jsonapi)                | OpenAPI support for the JSON:API module.                        |
| [**OpenAPI for REST**](https://www.drupal.org/project/openapi_rest)                       | OpenAPI support for the REST module.                            |
| [**ReDoc for OpenAPI UI**](https://www.drupal.org/project/openapi_ui_redoc)               | Provides display of OpenAPI docs using the ReDoc library.       |
| [**Swagger UI for OpenAPI UI**](https://www.drupal.org/project/openapi_ui_swagger)        | Provides display of OpenAPI docs using the Swagger UI plugin.   |
| [**Simple OAuth (OAuth2) & OpenID Connect**](https://www.drupal.org/project/simple_oauth) | The OAuth 2.0 Authorization Framework                           |
| [**REST UI**](https://www.drupal.org/project/restui)                                      | Provides a user interface to manage REST resources.             |
| [**JSON:API Extras**](https://www.drupal.org/project/jsonapi_extras)                      | Builds on top of JSON:API to deliver extra functionality.       |
| [**JSON API Defaults**](https://www.drupal.org/project/jsonapi_extras)                    | Builds on top of JSON API to deliver extra functionality.       |

## Listed in the extra components

Can be installed in the extra components installation step with Varbase.

<figure><img src="/files/TUqVRJWUDldSn0ZJfRul" alt=""><figcaption><p>Varbase API in the List of Varbase Extra Components Installation Step</p></figcaption></figure>

{% content-ref url="/pages/-MizASUiYABXxt3U6nTL" %}
[Configuring JSON:API Features](/10.0.x/developers/configuring-a-varbase-site/configuring-json-api-features.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.varbase.vardot.com/10.0.x/developers/understanding-varbase/optional-components/varbase-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.