Endpunkte
Die viewneo API stellt RESTful-Endpunkte zur Verwaltung von Mediendateien, Playlists, Geräten und anderen Ressourcen bereit.
Interaktive API-Dokumentation
Abschnitt betitelt „Interaktive API-Dokumentation“Die vollständige Endpunktreferenz ist über die interaktive Swagger UI verfügbar:
https://cloud.viewneo.com/doc/apiDie Swagger UI ermöglicht Ihnen:
- Alle verfügbaren Endpunkte mit ihren HTTP-Methoden durchsuchen
- Anfrageparameter und Antwortschemata anzeigen
- Endpunkte direkt in Ihrem Browser testen
- Beispiel-Anfragen und -Antworten einsehen
Basis-URL
Abschnitt betitelt „Basis-URL“Alle Endpunkte verwenden die folgende Basis-URL:
https://cloud.viewneo.com/api/v1.0/Häufig verwendete Endpunkte
Abschnitt betitelt „Häufig verwendete Endpunkte“| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /playlist | Alle Playlists auflisten |
| POST | /playlist | Neue Playlist erstellen |
| GET | /playlist/{id} | Bestimmte Playlist abrufen |
| PUT | /playlist/{id} | Playlist aktualisieren |
| DELETE | /playlist/{id} | Playlist löschen |
| GET | /mediafile | Alle Mediendateien auflisten |
| POST | /mediafile | Mediendatei erstellen/hochladen |
| GET | /device | Alle Geräte auflisten |
| GET | /devicegroup | Alle Gerätegruppen auflisten |
Daten senden
Abschnitt betitelt „Daten senden“Die API erwartet Daten im JSON-Format. Fügen Sie die folgenden Header ein:
Content-Type: application/jsonAuthorization: Bearer YOUR_ACCESS_TOKENBeispiel: Playlist erstellen
Abschnitt betitelt „Beispiel: Playlist erstellen“curl -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ -d '{"name": "My Playlist", "comment": "Created via API"}' \ 'https://cloud.viewneo.com/api/v1.0/playlist'Antwort:
{ "name": "My Playlist", "comment": "Created via API", "company_id": 221, "updated_at": "2017-01-24 16:37:20", "created_at": "2017-01-24 16:37:20", "id": 16047}