Documentation API
L'utilisation de l'API est conditionnée par la présence d'une clé API pour l'authentification. Ce service est inutilisable sans moyen d'authentification même si vous l'utilisez en mode d'essai. Pour cela, vous devez vous inscrire et souscrire au plan gratuit afin d'obtenir une clé API valide pour commencer à utiliser le service. Aucun des services et terminaux de l'API n'est disponible sans authentification. L’API comporte quatre points de terminaison détaillés ci-dessous afin d’appeler individuellement une image, une vidéo ou une sélection d’images ou de vidéos.
Photos
GET /api/v1/photo/reference?api_key=nlp_key_***
GET /api/v1/photos?categories=***;***&tags=***;***&api_key=nlp_key_***
Ce point de terminaison de l'API vous permet d’obtenir une ou plusieurs images depuis la plateforme. Vous pouvez appeler le point de terminaison photo API avec la méthode GET suivi de la référence de l’image dont vous souhaitez obtenir les données. La référence est un élément obligatoire. Vous obtiendrez une erreur si vous appelez ce point de terminaison sans préciser cet élément dans l’URL. Notez que cette référence est incluse dans l’URL et ne doit pas être ajoutée en paramètre. Vous devez ensuite préciser le paramètre obligatoire api_key en ajoutant votre clé d’API afin d’obtenir votre résultat si la ressource correspondant à la référence que vous avez demandée existe.
Si vous souhaitez obtenir plusieurs images vous devez appeler le point de terminaison photos API avec la méthode GET. Afin d’obtenir des résultats correspondant à une recherche précise vous avez la possibilité de préciser des paramètres facultatifs que sont la ou les catégorie(s) et le ou les tag(s) auxquels vous souhaitez que les images que vous allez obtenir en résultat soient associés. Si vous effectuez votre requête en incluant plusieurs catégories et/ou plusieurs tags, ces derniers devront être séparés par des points-virgules comme présenté dans l’exemple ci-dessus. Un maximum de 50 résultats vous seront retournés et ce quels que soient les paramètres que vous avez précisés afin d’éviter que les requêtes soient trop longues et les résultats trop nombreux. Si vous ne précisez aucun paramètre ce sont des résultats aléatoires que vous obtiendrez en réponse. Comme pour le premier point de terminaison, vous devez ensuite préciser le paramètre obligatoire api_key en ajoutant votre clé d’API afin d’obtenir une réponse valide.
Chaque objet image présent dans la réponse que vous obtiendrez aura la forme suivante
Photo
{
"reference": "pho-d98d80aef1e683fc59af8d4b4bf6404e",
"image": "https://nightlapse-photo.com/...",
"title": "Title",
"description": "Description",
"taken at": "01/01/2021",
"contributor": "NightLapse Photo",
"camera type": "Digital Single-Lens Reflex",
"camera": "Camera",
"lens": "Lens",
"focal": "18mm",
"exposure": "1/500s",
"aperture": "f/2.8",
"iso": "1000",
"categories": {
"nature and landscapes",
"animals and wildlife"
}
"tags": {
"alp",
"lakeside",
"cliff",
"promontory",
"seashore"
}
}
Vidéos
GET /api/v1/video/reference?api_key=nlp_key_***
GET /api/v1/videos?categories=***;***&tags=***;***&api_key=nlp_key_***
Ce point de terminaison de l'API vous permet d’obtenir une ou plusieurs vidéos depuis la plateforme. Vous pouvez appeler le point de terminaison video API avec la méthode GET suivi de la référence de la vidéo dont vous souhaitez obtenir les données. La référence est un élément obligatoire. Vous obtiendrez une erreur si vous appelez ce point de terminaison sans préciser cet élément dans l’URL. Notez que cette référence est incluse dans l’URL et ne doit pas être ajoutée en paramètre. Vous devez ensuite préciser le paramètre obligatoire api_key en ajoutant votre clé d’API afin d’obtenir votre résultat si la ressource correspondant à la référence que vous avez demandée existe.
Si vous souhaitez obtenir plusieurs vidéos vous devez appeler le point de terminaison videos API avec la méthode GET. Afin d’obtenir des résultats correspondant à une recherche précise vous avez la possibilité de préciser des paramètres facultatifs que sont la ou les catégorie(s) et le ou les tag(s) auxquels vous souhaitez que les vidéos que vous allez obtenir en résultat soient associés. Si vous effectuez votre requête en incluant plusieurs catégories et/ou plusieurs tags, ces derniers devront être séparés par des points-virgules comme présenté dans l’exemple ci-dessus. Un maximum de 50 résultats vous seront retournés et ce quels que soient les paramètres que vous avez précisés afin d’éviter que les requêtes soient trop longues et les résultats trop nombreux. Si vous ne précisez aucun paramètre ce sont des résultats aléatoires que vous obtiendrez en réponse. Comme pour le premier point de terminaison, vous devez ensuite préciser le paramètre obligatoire api_key en ajoutant votre clé d’API afin d’obtenir une réponse valide.
Chaque objet vidéo présent dans la réponse que vous obtiendrez aura la forme suivante
Vidéo
{
"reference": "vid-d01eafaea98d7afcf5f757c50cd38c45",
"video": "https://nightlapse-photo.com/...",
"title": "Title",
"description": "Description",
"recorded at": "01/01/2021",
"contributor": "NightLapse Photo",
"camera type": "Cinema camera",
"camera": "Camera",
"lens": "Lens",
"duration": "0:25",
"categories": {
"nature and landscapes",
"animals and wildlife"
}
"tags": {
"alp",
"lakeside",
"cliff",
"promontory",
"seashore"
}
}