Stack Exchange Network

Stack Exchange network consists of 175 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

Questions tagged [plugin-elementapi]

Plugin that makes it easy to create a JSON API for your elements, from Pixel & Tonic.

1
vote
0answers
11 views

Query element api (output) via plugin

Is there a way to fetch the content generated by the Element API via a plugin. For example, if we have created an ingredients/<slug:{slug}>.json endpoint, can the data for a specific page (eg ...
0
votes
1answer
19 views

Element API unable to get all() of matrix field

I'm getting matrix block content from an entry type which works fine for the most part. It's probably clearer to just paste in the code: Current element api code: $relationsData = []; if($entry-&...
0
votes
0answers
18 views

Shopify - Connect existing Element API/Vue JS site to new Shopify store

I have a Craft 3 site, currently running using the Element API and Vue JS as follows: VueJS: Product grid component ... mounted(){ this.getGridProducts() }, data() { return { ...
0
votes
0answers
9 views

Getting elements by field value in related entry

I'm trying to get some results using elementapi but not sure how best to go about it. I have entries in one section - call it Players - that include a relation to another entry School. School entries ...
1
vote
1answer
20 views

Get a specific product with Element API, Commerce and Craft 2

How do I get a specific product via Element API? Here's what i have so far 'api/product' => function() { $productId = craft()->request->getRequiredQuery( 'productId' ); return [ ...
1
vote
1answer
16 views

Get last change timestamp in header response

I'll be polling an endpoint created with the element-api plugin which will trigger a concourse build. I need to include a timestamp the last time any entry was changed. So I need something to go in ...
1
vote
0answers
11 views

element-api: include a collection with mixed entry types, and nested includes

Does anyone know how to include a collection of entries, containing multiple entry-type, in such way that: 1. Each entry type gets transformed by its own custom transformer class (tailord to the ...
1
vote
0answers
15 views

Retrieving Entries by Category & Exclude by Tag

I have an endpoint that I want to retrieve entries by a category, but then exclude entry ids if they have a certain tag. It seems to me that the relatedTo param overrides the id param that says not in ...
0
votes
0answers
21 views

Using Element API with Digital Products

I'm trying to set up the Element API to get Digital Products. I've managed to get regular commerce products like this: use craft\commerce\elements\Product; return [ 'elementType' => Product::...
1
vote
1answer
25 views

Element api JSON output formatting

I want to output all globals with one endpoint. This is trivial for the most part but I need to have some objects in a specific shape. I'm using a matrix block to handle the content. The main issue ...
1
vote
1answer
27 views

Element API: Is it possible to ignore/skip an Entry?

I would like to exclude some of my entries, via my own validation inside the Transformer, from the api output. Is there a possibility to move on to the next Entry without outputing anything? Right ...
1
vote
1answer
26 views

How I’ll get an entryId based on a given URL?

I want to configure deeplinks for an app and want to set up 'universal links'. Right now I'll send an entry id to the element api to get the right content. But with universal links I didn't have a ...
1
vote
1answer
53 views

Element API throws 404 when not logged into CP

My element API endpoint throws a 404 when I'm logged out of the CP, but works fine when I'm logged in. When logged out it throws a regular 404 with stack trace exactly as any other non-existing url, ...
2
votes
1answer
76 views

Element API calling Module that integrates with third-party plugin

This is probably a bit niche but anyone especially au fait with the element api here? On project X I have a custom module within which I am referencing a service from another plugin (bolden/google-...
1
vote
1answer
25 views

Craft update process affecting Element API cache

I have a site A using the Element API plugin to feed content to site B via JSON and handlebars templates. The process is both sites are up to date with content 'x' and it works fine. When I run the ...
0
votes
1answer
50 views

How to reset a multi-value checkbox using EVENT_AFTER_SAVE_ELEMENT in Craft 3?

I'm porting the functionality of an existing plugin from another CMS into Craft 3 through a custom Craft module. The functionality is: When an option from a multi-value checkbox is checked on the "...
1
vote
0answers
63 views

Group by Date Field in Element API Query

I have a custom field called releaseDate in one of my entry types. I would like to use Element API to get all the distinct years assigned to those entries. I dump all the years for all entries just ...
1
vote
1answer
26 views

Matrix block Element API call on null error

I get this JSON error when trying to output content of a matrix block called proLinks using the Element API. Call to a member function all() on null The code is as follows (I've shortened it and ...
2
votes
0answers
127 views

Element API SearchQuery to search for value inside child-entries

I currently try to use the Element API to build a search. Unfortunately I'm kind of stuck. I have a baseEntry, that has a field that references entries (let's call them subEntries) of the section ...
1
vote
1answer
72 views

Use conditional for Element API results?

Using the Element API is there a way to get entries by dateUpdated OR dateCreated within the last whatever time, say day? Or a way to get the entry IDs for both of those criteria then do a query ...
1
vote
0answers
50 views

Get field type of product or variant with element api

Trying to get type of a field (dropdown, checkbox, etc) to render those fields in app, there is all sorts of info available in $variant->fieldLayout->fields like handles, values, ids except type ...
2
votes
1answer
48 views

Disable dateUpdated

I am using Craft 3 to populate content over a REST api. Now I have a use case, where I want to update an internal field of an entry without changing the dateUpdated. Otherwise the clients would get ...
2
votes
1answer
113 views

Exposing current Commerce2 Cart via the Element API

I want to be able to retrieve the current users Cart via a JSON API endpoint, so I can loop through the products in the cart in JS on the front end. I've got the Element API plugin installed, but I ...
1
vote
1answer
19 views

Check if title field has a string in ElementAPI

I am trying to retrieve search suggestions for a search form. I sent the parameter entered by the user, but how do I do it in the criteria? I tried this: 'criteria' => [ 'search' => 'title: ...
1
vote
1answer
146 views

Getting Commerce Products using Element API in Craft 3

I am trying to get Products using the Element API plugin. I set the 'elementType' to Commerce_Products, CommerceProducts, etc.., but the endpoint keeps returning: Endpoint has an invalid ...
1
vote
1answer
159 views

Element-API migration - entries by category

I am having trouble getting the related category passed thru to the entry api endpoint. I cant use : $criteria = craft()->elements->getCriteria(ElementType::Category); $criteria->...
0
votes
0answers
61 views

Using Embedded Assets Plugin With Element API

When using the Element API, how do you go about using the Embedded Assets plugin? With a regular asset, in the API transformer you can pull out assets and include them like this: 'transformer' => ...
2
votes
1answer
143 views

Element API, VueJs and Imager!

I'm trying to do something akin to Andrew's excellent article whereby I have a 'more' button that spits out 6 more entries at a time. I'm nearly there, but running into some issues. I don't get past ...
1
vote
1answer
220 views

Craft 3 Element API Authentication/Login

First things first: This is quite similar to this, yet different. I'm trying to get authentication/login for Element-API for Craft 3 to work. Meaning I would like to restrict access to certain ...
1
vote
1answer
180 views

Element API - Entries Related to a Category

In Craft 3, I want to list all the categories in a group and all the entries related to them. How can I do this?
1
vote
2answers
188 views

Calling Craft API from node.js

I really love working with Craft, especially around how easy and user friendly it is. However, I do work with React/Vue and usually I setup a node server/app that will do some routing, render views ...
1
vote
1answer
126 views

How do you use the Element API plugin to output Assets from Matrix block for an entry?

I have Single Section(entry) with Matrix field which contains Assets in blocks. I'm trying to fetch assets from a single Matrix block. My element-api.php code is: <?php use craft\elements\Entry; ...
0
votes
2answers
119 views

Use Imager plugin with Element API?

I'm trying to use the Imager-Craft plugin to make specific image transformations, but cannot figure out how to access Imager within the element-api.php file. Imager shows plenty of template examples, ...
0
votes
0answers
26 views

ElementAPI fetching categories' children not returning localized elements

I followed Brandon's explanation in this thread to fetch all categories' children with the ElementAPI. But when I add the locale to the criteria, I don't get the localized children elements. Do I ...
1
vote
1answer
56 views

Element-API: Access the first url of an asset array

I have an asset field in my current project with the handle postImage, containing multiple image files. In my element-api endpoint, I wish to access the url of the first file only. I tried the ...
1
vote
1answer
38 views

Loop over table field in Element API plugin

How can I output the rows and values of a table field using the element api plugin? Where I have entries I do ... $industries = []; foreach ($entry->industries->all() as $industry) { $...
1
vote
1answer
87 views

Element API and Shopify plugin

Is there any way to translate this: {% set shopify = craft.shopify.getProductById({ id: entry.shopifyProduct, fields: 'variants, id' }) %} to the Element API? I've tried this, but obviously it ...
6
votes
1answer
261 views

Is there a way to split the element-api.php file?

Is there some way I can split the element-api.php file into separate files and import them all? It's getting quite long and unwieldy.
2
votes
1answer
111 views

Getting all the values out of a field as array of values

I have a multi-select field in my work section I want to get the values either with the Element api as json or an array of simple values in my template.
0
votes
0answers
97 views

Include the asset's volume in the eager loading. [Element API]

On Element API, I'm eager loading the header image like: $criteria = [ 'section' => $section, 'with' => ['categories', 'header_image'] ]; But, in the output, I cannot get the volume ...
1
vote
0answers
33 views

Check the field type of all the attributes of an entry

Here's the whole picture: I'm trying to make an API endpoint which should output everything from an entry: First I did this: public function transform(Entry $entry) { return $entry-...
1
vote
1answer
92 views

Matrix block fields returning NULL when using MatrixBlock query

$blocks = MatrixBlock::find()->relatedTo($entry)->all(); The above returns the correct blocks but all fields are returned as NULL. I've read over at GitHub that we need to specify a fieldId ...
1
vote
0answers
233 views

Element API plugin: searching and working with nested objects

I’m experimenting with the Element API plugin and working with querying the tags of the assets that appear in matrix blocks in a set of entries. Essentially I’m hoping to be able to use a tag in a ...
2
votes
1answer
425 views

Write to Craft via Element API

I’d like to use Craft as a headless CMS for my mobile app (via the Element API plugin). However, in addition to reading data, I’d also like to write data back to Craft. It looks like this is ...
2
votes
1answer
102 views

Restrict access to Element API endpoint

I'd like to Restrict access to Element API endpoint by the current user's group. Is this possible Using Craft 2?
2
votes
1answer
419 views

Element API: Get Matrix Content

So I'm trying to get my Matrix as JSON with the Craft CMS Element API plugin. <?php use Craft\elements\Entry; return [ 'endpoints' => [ 'api/sites' => [ '...
1
vote
1answer
40 views

Can I output custom or specific data (Not related to an elementType) on Element API?

For example, an endpoint to retrieve all the languages available on the website 'endpoints' => [ 'languages' => function () { $sites = Craft::$app->getSites()->...
4
votes
1answer
258 views

Craft 3 Element API: Query the “parent” entry of a “child” entry with Matrix blocks connected by an 'Entries' field

In a Matrix block field of a "page" entry, I'm using an Entries field to manually select a list of "article" entries to the "page" entry. When I query an "article" entry, is it possible to query its "...
1
vote
1answer
221 views

Craft 3: get enabled sites of an entry

I'm looking for a way to list all the enabled sites for a given entry. I couldn't find some sort of getEnabledSites method that's similar to the available getSupportedSites. The latter only returns ...
0
votes
0answers
66 views

Getting Solspace Calendar Events with ElementAPI

I have started to use ElementAPI and Solspace Calendar plugins on a project and I'm trying to get a JSON feed of all events so I can dynamically load certain events with ajax. Here's a question about ...