Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heimrichhannot/contao-api-bundle
API to access (restricted) contao privacy module from 3rd-party applications
https://github.com/heimrichhannot/contao-api-bundle
Last synced: about 1 month ago
JSON representation
API to access (restricted) contao privacy module from 3rd-party applications
- Host: GitHub
- URL: https://github.com/heimrichhannot/contao-api-bundle
- Owner: heimrichhannot
- Created: 2018-09-10T14:34:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T06:52:20.000Z (over 1 year ago)
- Last Synced: 2024-10-14T14:18:42.488Z (2 months ago)
- Language: PHP
- Size: 160 KB
- Stars: 5
- Watchers: 6
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Contao api bundle
[](https://packagist.org/packages/heimrichhannot/contao-api-bundle)
[](https://packagist.org/packages/heimrichhannot/contao-api-bundle/stats)
[](https://travis-ci.org/heimrichhannot/contao-api-bundle/)
[](https://coveralls.io/github/heimrichhannot/contao-api-bundle)
A generic API with restricted access to provide access to 3rd party applications.
## Login `/api/login/member` or `api/login/user`
Login is done via symfony `guard` authenticator in combination with contao members `tl_member` or users `tl_user`.
After successful login a volatile token (default: `24 hours`) will be returned that is used for any api and must be provided within request headers `Authorization: Bearer {{token}}`;
```
# test login (with contao front end member)
curl --user username:password -H "Content-Type: application/json" -X POST http://domain.tld/api/login/member
# example response on success
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmXtZSI6ImRpZ2l0YWxlc0BoZWltcmljaA1oYW5ub3QuZGUiLCJpYXQiOjE1MzY4NTYwMDMsImV4cCI6MTUzNjk0MjQwM30.trp-1NgYgXGfHYdE3dlQ8awE8aXUWL-RfBQyfWm2Hz0"
}
# test login (with contao back end member)
curl --user username:password -H "Content-Type: application/json" -X POST http://domain.tld/api/login/user
# example response on success
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmXtZSI6ImRpZ2l0YWxlc0BoZWltcmljaA1oYW5ub3QuZGUiLCJpYXQiOjE1MzY4NTYwMDMsImV4cCI6MTUzNjk0MjQwM30.trp-1NgYgXGfHYdE3dlQ8awE8aXUWL-RfBQyfWm2Hz0"
}
```
## Create an app with an custom api key
Visit your contao backend at `http://domain.tld/contao?do=api_apps` and create your first app.
Access can be restricted for member or user groups. Admin users `tl_user` will have access to every api by default.
For each request beside the login routes you must provide the generated API `key` as `GET` Parameter.
## Resource /api/resource/{resource_alias}
To add your custom resource, simply add an service within your bundles or app `services.yml`:
```
services:
my.api.resource.my_resource:
class: MyApi\Resource\MyResource
arguments:
- "my_resource"
tags:
- { name: huh.api.resource, alias: my_resource}
```
And register your resource configuration within your bundles or app `config.yml`:
```
huh:
api:
resources:
- {name: my_resource, type: entity_resource, modelClass: "MyResourceModel", verboseName: my_resource}
```
To get your `config.yml` loaded properly, your `Plugin` class must implement the interface `Contao\ManagerPlugin\Config\ExtensionPluginInterface`:
```
namespace MyApi\ContaoManager;
use Contao\ManagerPlugin\Config\ContainerBuilder;
use Contao\ManagerPlugin\Config\ExtensionPluginInterface;
use HeimrichHannot\UtilsBundle\Container\ContainerUtil;
class Plugin implements ExtensionPluginInterface
{
/**
* {@inheritdoc}
*/
public function getExtensionConfig($extensionName, array $extensionConfigs, ContainerBuilder $container)
{
return ContainerUtil::mergeConfigFile(
'huh_api',
$extensionName,
$extensionConfigs,
__DIR__.'/../Resources/config/config.yml'
);
}
```
**Do not forget to clear the symfony cache afterwards!**
Now you are able to access your resource through `/api/resource/my_resource`.
```
# test access to my_resource (provide your token from user or member login and your api key)
curl --header "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmXtZSI6ImRpZ2l0YWxlc0BoZWltcmljaA1oYW5ub3QuZGUiLCJpYXQiOjE1MzY4NTYwMDMsImV4cCI6MTUzNjk0MjQwM30.trp-1NgYgXGfHYdE3dlQ8awE8aXUWL-RfBQyfWm2Hz0" -H "Content-Type: application/json" -X GET http://domain.tld/api/resource/my_resource?key=
```
Now you are able to access crud functionality by using the related `HTTP method`:
| Path | HTTP-Method | Resource-Method (Mapping) |
|---|---|---|
| /api/resource/my_resource | POST | create() new resource |
| /api/resource/my_resource/23 | PUT | update() existing resource with id 23 |
| /api/resource/my_resource | GET | list() all resources |
| /api/resource/my_resource/23 | GET | show() existing resource with id 23 |
| /api/resource/my_resource/23 | DELETE | delete() existing resource with id 23 |
```
# test create() new resource
curl --header "Authorization: Bearer " -H "Content-Type: application/json" -X POST -d "{"title":"My test title", "published":true}" http://domain.tld/api/resource/my_resource?key=
```
```
# test update() existing resource
curl --header "Authorization: Bearer " -H "Content-Type: application/json" -X PUT -d "{"title":"My new test title", "published":false}" http://domain.tld/api/resource/my_resource/23?key=
```
```
# test list() all resources
curl --header "Authorization: Bearer " -H "Content-Type: application/json" -X GET http://domain.tld/api/resource/my_resource?key=
```
```
# test show() existing resource
curl --header "Authorization: Bearer " -H "Content-Type: application/json" -X GET http://domain.tld/api/resource/my_resource/23?key=
```
```
# test delete() existing resource
curl --header "Authorization: Bearer " -H "Content-Type: application/json" -X DELETE http://domain.tld/api/resource/my_resource/23?key=
```
### Available Resources
#### Service: huh.api.resource.member
Skeleton resource that provides simple crud functionality with contao member (tl_member) entity
| Path | HTTP-Method | Resource-Method (Mapping) | Additional GET Parameters
|---|---|---|---|
| /api/resource/member | POST | create() new member | - |
| /api/resource/member/23 | PUT | update() existing member with id 23 |- |
| /api/resource/member | GET | list() all member | limit, offset |
| /api/resource/member/23 | GET | show() existing member with id 23 | - |
| /api/resource/member/23 | DELETE | delete() existing member with id 23 | - |