API EarthRanger

Mis à jour à May 3rd, 2024

Des détails supplémentaires viendront plus tard

 

 

L'API EarthRanger est conçue pour offrir à chaque utilisateur un accès transparent au suivi et aux données en temps réel.

Commencer:

Bibliothèque Python : plongez dans notre bibliothèque Python disponible sur GitHub. Trouvez - le ici : https://github.com/PADAS/er-client

Exemples : https://github.com/PADAS/er-client/tree/main/docs/examples

Documentation complète de l'API REST : une fois connecté au portail d'administration EarthRanger , vous pouvez accéder à l'API REST complète, documentée ici : https://sandbox.pamdas. org/api/v1.0/docs/index.html

Documentation interactive : remplacez "sandbox" dans l'URL par le nom de votre serveur pour interagir directement avec l'API : https://sandbox.pamdas.org/ api/v1.0/docs/interactive/

 

 

Version de démarrage rapide ultra courte

Authentification

Nous utilisons des jetons OAuth2 pour l'authentification. Vous pouvez en créer un de longue durée ici : https://sandbox.pamdas. org/admin/oauth2_provider/ accesstoken/

 

Créer une observation (suivre l'emplacement ou la lecture du capteur)

Le concept général est qu'un fournisseur de sources est un service qui décrit une ou plusieurs sources fournissant des informations de localisation pour un sujet. Par exemple, un fabricant de dispositifs de localisation est un fournisseur de sources, un traqueur de rhinocéros est une source et le rhinocéros lui-même est le sujet. Dans cet esprit...

 

Comme d'habitude, les en-têtes d'API :

Autorisation : Porteur <jeton>

Accepter : application/json

Contenu-Disposition : pièce jointe ; nom de fichier={}

Type de contenu : application/json

 

Le corps d’une demande de localisation ressemble à :

{

"emplacement": {

"lat":47.123,

"lon":-122.123

},

"recorded_at": "2019-02-19T13: 59: 15.000Z",

"manufacturer_id": "SomeUniqueIDForTheDevice",

"subject_name": "Voiture 4",

"subject_type": "véhicule",

"subject_subtype": "voiture",

"model_name": "Land Cruiser",

"source_type": "tracking_dispositif",

"supplémentaire": {

"anykey": "n'importe quelle valeur"

}

}

 

Notez que si vous transmettez une observation où le système n'a pas vu cette combinaison source-fournisseur / fabricant_id avant de créer des sources et des sujets si nécessaire.

 

Créer un événement

Pour publier des événements, voici quelques exemples d'appels d'API :

 

POST sur https://sandbox.pamdas.org/api/v1.0/activity/events

 

En-têtes :

· Autorisation : Porteur xxxxxxxx

· Accepter : application/json

· Contenu-Disposition : pièce jointe ; nom de fichier={}

· Type de contenu : application/json

 

Exemple de corps :

{

"event_type": "mist_rep",

"heure": "2019-01-17T06:18:44.056439",

"priorité": 100,

"emplacement": {

"latitude": 47.123,

"longitude": -122.123

},

"Détails de l'évènement": {

"mistrep_Method": "Évacuation de l'air",

" mistrep_Injury": "Paludisme",

"mistrep_Symptoms": "Fièvre et transpiration",

"mistrep_Treatment": "Médecine antipaludique"

}

}

 

Notez que event_type et les champs pour event_details correspondent à l'entrée dans la page Activité > Types d'événements de l'administrateur Django.