Lisez toute l’API avant de faire votre demande
La référence Engine est ouverte. Les ressources, les champs et les erreurs sont documentés avec des exemples, et rien ne se cache derrière un formulaire. Lorsque vous voulez essayer un appel, faites une demande de compte et créez une clé sandbox.
- À lire
- Aucun compte nécessaire
- Format
- Référence REST avec exemples
- Clés sandbox
- Avec un compte approuvé
Commencez par une requête
Le moyen le plus rapide de lire une API est de l’appeler. Ces quatre requêtes font une bonne première heure : vérifier que votre clé fonctionne, lister ce qui existe, créer une sortie et vous abonner aux événements.
- Chaque endpoint est présenté avec une requête et une réponse
- Les erreurs sont listées avec leur cause et leur solution
- Les exemples s’exécutent tels quels sur la sandbox
Premières requêtes
Exemples de requêtesGET/v1/me
Réponse
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}La référence, par ressource
- Sorties
- Créez, mettez à jour, envoyez et retirez des sorties, avec leurs territoires et leurs dates.
- Titres et fichiers
- Ajoutez des titres, importez l’audio et les pochettes, et définissez crédits, codes et répartitions.
- Livraisons
- Envoyez une sortie aux plateformes et suivez chaque destination, de l’attente jusqu’à la mise en ligne ou au refus.
- Statistiques
- Lisez les streams et les téléchargements par plateforme, territoire, sortie, titre et jour.
- Redevances
- Listez les relevés, lisez leurs lignes et voyez ce qui est dû à chaque bénéficiaire.
- Webhooks
- Enregistrez un endpoint, choisissez les événements qu’il reçoit et examinez ce qui a été envoyé.
Démarrage rapide, sur la sandbox
- 1
Créez une clé sandbox
Faites une demande de compte, puis copiez la clé depuis celui-ci une fois approuvé.
- 2
Faites votre première requête
Appelez /v1/me avec la clé dans l’en-tête Authorization pour confirmer qu’elle fonctionne.
- 3
Créez une sortie de test
Envoyez une sortie avec un titre et un artiste, puis ajoutez-lui un titre musical.
- 4
Simulez une livraison
Livrez-la en sandbox et regardez le statut évoluer, sans aucune plateforme.
Un en-tête, et vous êtes connecté
L’authentification est une clé d’API envoyée comme bearer token. Pas de handshake, pas de session à maintenir. Copiez ceci, remplacez par votre clé et lancez-le.
- La sandbox et la production utilisent des clés distinctes
- Une clé peut être révoquée à tout moment
Listez vos sorties
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"