Kies de juiste API-versie

De huidige app gebruikt de API /app/api/v1. Oudere integraties kunnen de aparte dienst api.screenapp.io/v2 gebruiken. De endpoints, inloggegevens en uploadstromen zijn niet uitwisselbaar.

Stel voordat u een bestaande integratie wijzigt vast welke basis-URL en accountgeneratie die gebruikt. Raadpleeg voor een oudere integratie de v2-referentie en vraag ScreenApp of migratie wordt ondersteund.

Een sleutel voor de huidige app maken

Open Instellingen > API in de huidige app. Maak een sleutel met een naam en de beperkste scopes die u nodig hebt, en bewaar hem zodra hij wordt getoond. Behandel hem als een geheim en trek hem in als hij is uitgelekt. Controleer of de sleutel bij uw persoonlijke account of bij een team hoort.

De huidige openbare scopes zijn files:read and files:upload.

Uw accountcontext opvragen

Zet SCREENAPP_API_KEY privé in uw omgeving. Zet de sleutel niet in HTML aan de clientkant en commit hem niet naar een repository.

curl --fail-with-body "https://screenapp.io/app/api/v1/me"   -H "x-api-key: $SCREENAPP_API_KEY"

Een bestand uploaden

Gebruik een sleutel met uploadrechten. Vervang de lokale bestandsnaam door uw eigen bestand.

curl --fail-with-body "https://screenapp.io/app/api/v1/videos"   -H "x-api-key: $SCREENAPP_API_KEY"   -F "file=@recording.mp4"

Het antwoord bevat de ID van het nieuwe bestand. De verwerking loopt op de achtergrond door. Vraag GET /app/api/v1/videos/{id} op tot transcriptStatus de waarde ready heeft en roep daarna GET /app/api/v1/videos/{id}/transcript aan.

Directe uploads via de huidige API hebben een limiet van 512 MB voor de request body. Dat is alleen een API-limiet: uploads in de app hebben geen vaste limiet voor de bestandsgrootte. Hetzelfde videos-endpoint accepteert ook een JSON-object met een openbare url in plaats van lokale bytes.

Opnames opvragen

GET /app/api/v1/videos toont de opnames in de ruimte van de sleutel.
GET /app/api/v1/videos/{id} geeft status en metadata terug.
GET /app/api/v1/videos/{id}/transcript geeft het transcript terug zodra het klaar is.

Gebruik leesrechten voor deze verzoeken. Een ontbrekende of ongeldige sleutel geeft 401, een onvoldoende scope geeft 403 en een rate limit geeft 429. Volg Retry-After als dat wordt meegegeven. Een transcript dat wordt opgevraagd voordat het klaar is, kan 409 teruggeven.

Een recorder insluiten

Insluiten heeft een eigen configuratie en een domeinbeperking. Volg een recorder insluiten. Gebruik nooit een privé REST-sleutel als insluittoken.

Deze voorbeelden beschrijven het huidige API-contract. Controleer ze in het account en de omgeving die u wilt gebruiken voordat u een werkende oudere integratie vervangt.