laravel-notion-api

Notion for Laravel: A Comprehensive Guide

Overview

Notion for Laravel is a powerful package designed to seamlessly integrate and interact with the Notion API through Laravel applications. Developed by Diana Scharf and Johannes Güntner, this package makes it effortless for developers to access Notion API endpoints, query data, and update existing entries within the Notion platform, all through a simplified and intuitive interface provided by Laravel.

Key Features

• Easy Integration: The package provides an easy way to connect Laravel applications to Notion, requiring minimal setup.
• Extensive Documentation: Users can access detailed documentation via notionforlaravel.com, which includes comprehensive context and usage examples to facilitate a smoother experience.
• Search and Query: The package supports complex searching and querying within Notion databases, allowing users to filter, sort, and retrieve data effectively.
• Version Compatibility: It supports Laravel 8, 9, and 10, with a minimum PHP requirement of version 8.0.

Installation

To start using this package, the following steps are required:

1. Install via Composer:

   composer require fiveam-code/laravel-notion-api
   

2. Obtain Notion API Token: Follow Notion's documentation to secure an API access token and grant necessary permissions.
3. Configure Environment Variables: Add your Notion access token to the .env file:

   NOTION_API_TOKEN="$YOUR_ACCESS_TOKEN"
   

4. Begin Access: Utilize the Notion facade to access endpoints:

   use \Notion;
   Notion::databases()->find("8284f3ff77e24d4a939d19459e4d6bdc");
   

Functionality Examples

• Fetch a Notion Database: Retrieve detailed information about a database, including all properties and possible values:

  use \Notion;
  Notion::databases()->find("8284f3ff77e24d4a939d19459e4d6bdc");
  

• Fetch a Notion Page: Get comprehensive details about a specific page:

  Notion::pages()->find("e7e5e47d-23ca-463b-9750-eb07ca7115e4");
  

• Search Functionality: Perform a search query across pages within the scope of the workspace:

  Notion::search("Search term")->query()->asCollection();
  

• Database Query: Query databases with specific criteria using filters and operators:

  use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
  use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
  
  $nameFilter = Filter::textFilter('Name', Operators::EQUALS, 'Ada Lovelace');
  \Notion::database("8284f3ff77e24d4a939d19459e4d6bdc")
      ->filterBy($nameFilter)
      ->limit(5)
      ->query()
      ->asCollection();
  

Testing and Quality

The project includes a suite of tests using Pest, aiming to ensure reliability and quality. Developers can run these tests with:

vendor/bin/pest tests

Contribution and Community

Developers are encouraged to contribute to the project by following the guidelines in the CONTRIBUTING document. Any security issues should be reported to [email protected] instead of through the issue tracker.

Conclusion

Notion for Laravel is an essential tool for developers looking to bring the power of Notion into their Laravel applications. With its straightforward integration, comprehensive documentation, and robust feature set, it is designed to enhance productivity and efficiency in managing and interacting with Notion data.

The project is licensed under MIT, ensuring open access and collaboration within the developer community.