https://github.com/in2code-de/instagram
Show instagram feed without API in a TYPO3 extension
https://github.com/in2code-de/instagram
instagram typo3 typo3-extension
Last synced: 7 months ago
JSON representation
Show instagram feed without API in a TYPO3 extension
- Host: GitHub
- URL: https://github.com/in2code-de/instagram
- Owner: in2code-de
- Created: 2020-04-29T14:46:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-25T21:46:32.000Z (over 2 years ago)
- Last Synced: 2025-04-24T01:15:54.130Z (about 1 year ago)
- Topics: instagram, typo3, typo3-extension
- Language: PHP
- Homepage: https://www.in2code.de/agentur/typo3-extensions/instagram/
- Size: 5.6 MB
- Stars: 21
- Watchers: 2
- Forks: 15
- Open Issues: 27
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Show a profile Instagram feed in TYPO3
## Introduction
In the past we did a lot of research to bypass the original Instagram API. Using the official interface is still pain.
Now version 6 of this extension respects that Instagram updated their website (some days ago) again and cover it
against image grapping. So, we decided now to use the official API in this extension to still deliver images on our
website.
Nevertheless we want to make the configuration as easy as possible even if there is some hard stuff for non-developers
now. Version 6 has some breaking changes because of the switch to the API now (see details below).
## Explanation
This extension is splitted into two parts. A scheduler where you can import an instagram feed into the database on
the one hand and on the other hand there is a plugin where you can show the feed on your page. The split gives us the
possibility to still show images even if the interface is broken and in addition there are no speed limitations with
this kind of architecture.
Because of the guidelines of Instagram/Facebook the first step to use the API must be done by yourself and by hand.
You have to add a facebook developer account and add a new "app". After that you have to get the token by yourself in a
browser. Once you have did this, the token can be refreshed automatically.
So you do not have to make the whole initialization again. See details
below.
## Installation
`composer require in2code/instagram`
## Configuration
### The facebook and instagram part
> [!NOTE]
> * The Instagram API is only available for Instagram Business accounts. If you have a private account, you have to switch to a business account first.
> * The Instagram account you want to access needs to be part of a developer Facebook account as well, otherwise it can't be added as tester to an application.
1. You need a individual Facebook account
2. Once you have a Facebook account, register as a developer at https://developers.facebook.com/
3. Add a new application.
4. Configure the integration ["Instagram API with Instagram Login"](https://developers.facebook.com/docs/instagram-platform/instagram-api-with-instagram-login/)
* Configure "Instagram Business Login". As a OAuth Redirect URL just use the URL of your homepage (e.g. https://www.in2code.de)
* Make some notes for your new "App ID", "App secret" and the "Redirect URI" - this will be needed later in the FlexForm
5. Under "Roles" add your Instagram account as a test account. _(see notes above)_
* You need to accept this on your Instagram account. Go to your Instagram account settings and then to "Apps and Websites" and add the new app as a tester.
6. Install the extension (if not yet done)
7. Add a Instagram plugin anywhere on your pages and open the edit view. Add "username", "App ID", "App secret" and "App return URL" and press "save"
8. Now you will see a button at the end of the FlexForm. Click on it and a new browser window is opened with the Instagram website. You have to login and accept the request. After that, you will be redirected to your homepage.
9. If you reload the plugin, you will see a green message that tells you that you now have a valid token and how long the token is valid (no worries, once you have created it, you can use a scheduler task to refresh it automatically)
10. Now, you have access to the API and you can add a new scheduler task and import images from the given user (You should frequently import the feed - e.g. every 30 minutes)
11. Once you have imported the images via scheduler, you can see the plugin output in the frontend with the given feed
12. Don't forget to add an additional scheduler task to frequently refresh the token validation after 30-50 days, because the long-live token in Instagram expires after 60 days.
### CLI commands
#### Import images
If you have access to the instagram API (look at the FlexForm in the plugin and watch for the green message), you can
import images via CLI or scheduler.
Import the latest 25 posts from `in2code.de`:
`./vendor/bin/typo3 instagram:importfeed in2code.de`
Import some posts and get notified if error happens via Email:
`./vendor/bin/typo3 instagram:importfeed in2code.de service@in2code.de`:
#### Refresh tokens
Because long-live-tokens are only valid for 60 days, you can automatically refresh them after some days - with:
`./vendor/bin/typo3 instagram:refreshtoken in2code.de`
#### Remove all tokens
If you change your instagram password, all generated tokens are not useable any more. You have to add new ones. But
first of all, you can delete them:
`./vendor/bin/typo3 instagram:removetokens`
### Scheduler
#### Import images
Add a new scheduler task of type `Execute console commands (scheduler)` and select `instagram:importfeed`. Now you can
add a frequency (e.g. `*/30 * * * *` for every 30 minutes), a instagram username and one (or more) email address if
error happens (and you want get notified).
| Field | Description |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| username | Every task can import current posts from one user. If you want to show more feeds, you have to add more tasks. |
| receivers | Optional: Get notified via email if a CURL error occurs (e.g. if instagram blocks your requests). Commaseparated email list is provided. |
#### Refresh tokens
There is a new scheduler task, that can be used to automatically refresh Instagram tokens. We would do this after 30-50
days because a long-live token is valid for only 60 days.
Add a new scheduler task of type `Execute console commands (scheduler)` and select `instagram:refreshtoken`. Now you can
add a frequency (e.g. `0 5 */30 * ` for every 30 days at 5 am) and a instagram username.
### HTML output modification
Overwrite and modify the HTML output:
```
plugin {
tx_instagram_pi1 {
view {
templateRootPaths {
0 = EXT:instagram/Resources/Private/Templates/
}
}
}
}
```
Example html:
```
} "{image.caption -> f:format.crop(maxCharacters: 120, append: ' ...')}")
If image is not available on the local machine (for any reasons), load from instagram directly
{image.caption}
```
### Styling
If you want to have basic styling for the default layout present in the extension, you can include the
static template "Instagram" on your page.
## Screenshots
### Example frontend output:
### Plugin in backend:
### Plugin overview in backend page module:
## Technical corner
How to use the facebook/instagram API in general and how to test it?
See documentation: [ApiDocumentation](Documentation/InstagramApi.md)
## FAQ
### Q: The configuration in Instagram sounds complicated
A: Yes, we did a lot in the past to give you a gdpr proved and quick to install solution to show your instagram images
on your website. Now Instagram updated their websites again, to block "easy" image grabbing. At the moment we do not
see a simpler way then described above and also respect privacy for your visitors.
### Q: I clicked the button in the FlexForm and accepted but after that an error is shown
A: Instagram redirect you back to the configured url. If this is (e.g.) your startpage a PSR-15 middleware is listening
for GET params like `&code=foo`. This param is given from Instagram (not from us).
### Q: There is no (e.g. german) translation of the plugin
A: Yes, at the moment we focussed on english to speed up developing.
### Q: Token is only valid for 60 days. Do I have to refresh it manually?
A: No, if there is a valid token, you can refresh it (e.g.) after 30 days automatically via another scheduler task.
### Q: Error "OAuthException: Insufficient developer role Code: 400" comes up after clicking the button?
A: Take care that you are logged in into facebook with your developer account at the same time
### Q: How to add a GDPR-known button in frontend for the visitors?
A: No worries, this extension is absolutely GDPR-friendly. Text and images are stored anonymized on the server. No button needed for this.
### Q: Can I access to any instagram account?
A: No, because Instagram wants you to enable the access to the account, the owner has to accept this.
### Q: Is an approvement needed when building a Facebook app?
A: No, an approvement from Facebook is not needed.
### Q: Instagram password was changed - now I can't update the feed.
A: If you change the instagram password, all tokens are not valid any more. An error comes up like
```
{"error":{"message":"Error validating access token: The session has been invalidated because the user changed their pass (truncated...)
```
In this case you have to remove all tokens (see CLI section above) and create new ones from the scratch.
## Contribution with ddev
This repository provides a [DDEV]()-backed development environment. If DDEV is installed, simply run the following
commands to quickly set up a local environment with example usages:
* `ddev start`
* `ddev initialize`
### Requirements
1. Install ddev, see: https://ddev.readthedocs.io/en/stable/#installation
2. Install git-lfs, see: https://git-lfs.github.com/
### Installation
1. Clone this repository
2. Run `ddev start`
3. Run `ddev initialize` to setup configurations and test database
## Branchinfo
* master Branch - Next Major Version
## Early Access Programm for TYPO3 14 support
:information_source: **TYPO3 14 compatibility**
> See [EAP page (DE)](https://www.in2code.de/agentur/typo3-extensions/early-access-programm/) or
> [EAP page (EN)](https://www.in2code.de/en/agency/typo3-extensions/early-access-program/) for more information how
> to get access to a TYPO3 14 version
## Changelog
| Version | Date | State | Description |
|-----------|------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 13.0.1 | 2025-07-26 | Task | Move extension icon to Configuration folder |
| 13.0.0 | 2025-03-19 | Task | Support TYPO3 12 and 13 now |
| 8.0.0 | 2023-10-24 | Task | Support TYPO3 11 and 12 now |
| 7.2.0 | 2023-02-16 | Task | Add PHP 8 support |
| 7.1.0 | 2022-09-22 | Feature | Add optional static file include for styling of default layout |
| 7.0.0 | 2022-02-21 | Task | Support TYPO3 10 and 11 now |
| 6.2.1 | 2021-10-01 | Bugfix | Prevent exception if image is a video |
| 6.2.0 | 2021-07-09 | Feature | Add comand that allows you to delete all existing tokens |
| 6.1.3 | 2021-06-09 | Bugfix | Use thumbnail images when storing local to allow video previews |
| 6.1.2 | 2021-06-09 | Bugfix | Don't convert UserId to float value |
| 6.1.1 | 2021-06-09 | Task | Harden middleware with code recognization |
| 6.1.0 | 2021-04-13 | Task | Fix problem "Field id specified more than once. This is only possible before version 2.1" - because of a change of the instagram interface |
| 6.0.2 | 2021-03-17 | Task | Add extension key to composer.json file, small documentation update |
| 6.0.1 | 2021-03-15 | Bugfix | Change int to string field type for userId and appId to also handle large numbers |
| 6.0.0 !!! | 2021-03-15 | Task | Another rebuild now with the useage of the original Instagram API to grap images. See installation part in documentation what you have to do now. FlexForm, Scheduler and HTML-Templates have changed (this is a pitty, but have to be done). |
| 5.1.0 | 2021-01-21 | Feature | Render images in listview in webp format. |
| 5.0.2 | 2020-12-23 | Bugfix | Add a subject for error mails. |
| 5.0.1 | 2020-11-27 | Bugfix | Enable caching for the plugin. |
| 5.0.0 | 2020-11-16 | Feature | Pass a sessionid to instagram for blocked requests. Added a notification service for CURL errors. |
| 4.0.1 | 2020-11-14 | Bugfix | Fix typo in ext_tables.sql |
| 4.0.0 !!! | 2020-11-13 | Task | Add a scheduler task to import feeds (without RSS feed now). A plugin allows you to push the images into the frontend |
| 3.0.0 !!! | 2020-06-05 | Task | Use RSS-feed now for a workarround that server request are blocked by instagram |
| 2.0.0 | 2020-05-08 | Task | Store images locally now to improve privacy of your visitors. Use content element uid for building individual caches now |
| 1.1.0 | 2020-04-29 | Task | Open links in new tabs, don't cache the view because of own caching framework usage |
| 1.0.0 | 2020-04-29 | Task | Initial release |