README.md

Future Activities Craft 3 API

DEPRECATED - Use this instead: https://github.com/FutureActivities/Craft3-REST-API

This plugin attempts to create an API for Craft 3.

No need to configure anything as it will automatically start working.

Please be aware that this could be used to get information you may not want people to see, such as certain fields or entries restricted to certain users.

Currently this does not support multi-site. It is planned!

This is a work in progress - please do not use.

Entries

Get by ID

GET /api/entry/id/:id

Get by Slug

GET /api/entry/slug/:slug

Get by URI

GET /api/entry/uri/:uri

Supports any number of levels, e.g. /api/category/uri/news/category/post

Get Collection

GET /api/entry/collection

Pagination

To paginate the results just include a page and perPage parameter to the request.

api/collection?page=1&perPage=10

Filtering

To filter the results, include a filter parameter such as the following:

filter = [
    [
        'field' => '',
        'value' => ''
    ]
]

This will be added to the entry element query like so:

$entries = Entry::find();
$entries->$field = $value;

Which means you have a lot of control over the filters.

Basic Examples:

Get entries by section:

api/collection?filter[0][field]=section&filter[0][value]=news

Get all entries after a specific post date:

api/entry/collection?filter[0][field]=postDate&filter[0][value][]=>= 2018-07-31

Advanced Example:

Get all entries related to a category:

api/entry/collection?filter[0][field]=relatedTo&filter[0][value][sourceElement]=100&filter[0][value][field]=category

Response

By default, the response will be all the fields for each entry. You can override this with the response param and pass in a value such ids or count.

Categories

Get by ID

GET /api/category/id/:id

Get Collection

GET /api/category/collection

Tags

Get by ID

GET /api/tag/id/:id

Get Collection

GET /api/tag/collection

Users

To make requests about users you must first authenticate as a user and receive a token.

Get Authentication Token

POST /api/user/token

Sending a username and password on the POST request body.

Verify authentication token

GET /api/user/verifyToken/:token

Get Account

GET /api/user/account

Expects an authorization header like:

Bearer <token>

Register User

POST /api/user/register

With a POST body like:

{
    customer: {
        firstName: '',
        lastName: '',
        email: ''
    },
    password: ''
}

Send Password Reset Link

POST /api/user/sendPasswordReset

With a POST body like:

{
    username: ''
}

Do Password Reset

POST /api/user/doPasswordReset

With a POST body like:

{
    code: '',
    id: '',
    newPassword: ''
}

Update Account

PUT /api/user/account

General

Get details about a URI

GET /api/general/uri?uri=:uri

This will return the element type and ID

Events

After Parse Attributes

This is fired after an entry or categories fields are parsed. Allowing you to modify any values as needed in the response.

use futureactivities\api\services\Helper;
use futureactivities\api\events\AttributeEvent;

Event::on(Helper::class, Helper::EVENT_AFTER_PARSE_ATTRIBUTES, function(AttributeEvent $e) {
    $entry = $e->entry;
    $attributes = $e->attributes;
});

Cron

Expiring tokens

Out of the box, user authentication tokens will never expire. To expire tokens, setup a cron job running the following command:

./craft fa-api/token/expire <seconds>

<seconds> is optional. Default is 3600 seconds (1 hour).