https://github.com/teltek/pumukitexternalapibundle
https://github.com/teltek/pumukitexternalapibundle
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/teltek/pumukitexternalapibundle
- Owner: teltek
- Created: 2024-02-06T08:10:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-24T11:00:50.000Z (over 1 year ago)
- Last Synced: 2025-10-04T02:50:23.321Z (9 months ago)
- Language: PHP
- Size: 715 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ExternalAPIBundle
=================
WARNING: We cannot guarantee that this module is compatible with new versions of PuMuKIT.
This package allow to interact with PuMuKIT through an external API. It is a RESTful API that allows to create and update Multimedia Objects.
API Examples using curl:
##### New media package
```
curl -X POST -f -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/createMediaPackage
```
##### Add attachment without override
```
curl -X POST -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/addAttachment -F 'mediaPackage=""' -F 'flavor="srt"' -F BODY=@Resources/data/Tests/Controller/IngestControllerTest/subtitle.srt
```
##### Add attachment overriding attachment
```
curl -X POST -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/addAttachment -F 'mediaPackage=""' -F 'flavor="srt"' -F BODY=@Resources/data/Tests/Controller/IngestControllerTest/subtitle.srt -F 'overriding="5c982e5339d98b25008b456a"'
```
##### Add track
```
curl -X POST -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/addTrack -F 'mediaPackage=""' -F 'flavor="presenter/source"' -F BODY=@Resources/data/Tests/Controller/IngestControllerTest/presenter.mp4
```
##### Add episode (to change title)
```
curl -X POST -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/addDCCatalog -F 'mediaPackage=""' -F 'flavor="dublincore/episode"' -F BODY=@Resources/data/Tests/Controller/IngestControllerTest/episode.xml
```
##### Add PuMuKIT episode (to change metadata)
```
curl -X POST -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/addCatalog -F 'mediaPackage=""' -F 'flavor="pumukit/episode"' -F BODY=@Resources/data/Tests/Controller/IngestControllerTest/pmk.json
```
##### addMediaPackage (do previous ones simultaneously):
```
curl -X POST -f -i --basic -u admin:admin http://localhost:8000/app_dev.php/api/ingest/addMediaPackage -F contributor='test CURL' -F title='Test CURL' -F 'flavor[]=presentation/source' -F 'BODY[]=@Resources/data/Tests/Controller/IngestControllerTest/presentation.mp4' -F 'flavor[]=presenter/source' -F 'BODY[]=@Resources/data/Tests/Controller/IngestControllerTest/presenter.mp4'
```
API DELETE Examples using curl
##### removeTag: ( Remove the custom tag configured for external api )
```
curl -X DELETE -i --basic -u admin:admin https://localhost:8000/app_dev.php/api/mmobjs/5c982e5339d98b25008b456a/tags/cod/CUSTOM_TAG
```