Comment utiliser notre API
1
.
Qu'est-ce qu'une API ?
Le terme API signifie Application Programming Application Programming Interface (interface de programmation d'applications). Il s'agit d'un protocole de communication conçu pour simplifier l'échange de données entre un client et un serveur de données entre un client et un serveur. La communication la communication se fera dans un format strict, ou déclenchera une action particulière, afin qu'ils se complètent parfaitement.
Une clé API est un identifiant unique utilisé pour authentifier un utilisateur ou un programme qui invoque l'API.
2
.
Que signifie l'API pour les utilisateurs de notre plateforme ?
Cela signifie que vous pouvez utiliser l'API pour facilement envoyer des données à notre plateforme ou en extraire.
Envoyez vos propres données pour les combiner avec les données déjà présentes sur notre plateforme. Il peut s'agir de données provenant d'un système ERP ou CRM, ou de capteurs et de systèmes de mesure. Vous pouvez également demander des données pour les utiliser dans votre propre application.
3
.
Comment utiliser notre API et notre clé API ?
1. Créez une Création de clé API
L'API étant en version bêta publique, la clé API doit être demandée par courriel à être demandée par courriel à help@calculus.group. Vous pouvez nous contacter en envoyant un courrier électronique, avec pour objet "Request Clé API pour Calculus". Dans cet e-mail, veuillez nous indiquer pour quelle entreprise vous avez besoin de la clé API et ce que vous ferez pour l'obtenir pour quelle entreprise vous avez besoin de la clé API et à quelles fins vous l'utiliserez.
Please note! If the API key would be compromised, please email us at the same address to revoke the key to be revoked.
2. Utiliser l'API pour obtenir des données
Grâce à l'API, vous pouvez récupérer les données de tous les actifs associés à l'entreprise à laquelle appartient la clé API associés à l'entreprise à laquelle appartient la clé API. Le point de terminaison de l Pour récupérer les données est "https://api.calculus.group/asset/{key}". Remplacez {key} par l'identifiant unique de l'actif. Les appels sont effectués avec l'action HTTP "GET".
Paramètres
|
epochStart
|
Le début de la série temporelle pour laquelle vous avez besoin de données début de la série temporelle pour laquelle vous avez besoin de données. Le format de date et d'heure utilisé est "Epoch", le code temporel d'UNIX. Pour les outils de conversion de et vers Epoch, voir https://www.epochconverter.com/ pour les outils de conversion de et vers Epoch. Si vous utilisez ce paramètre, il doit toujours être utilisé avec le paramètre "epochEnd". Si elle n'est pas utilisée, la valeur par défaut est celle des dernières 24 heures. |
|
epochEnd
|
La fin de la série temporelle pour laquelle vous avez besoin de données fin de la série temporelle pour laquelle vous avez besoin de données. Le format de date et d'heure utilisé est "Epoch", le code temporel d'UNIX. Pour les outils de conversion de et vers Epoch, voir https://www.epochconverter.com/ pour les outils de conversion de et vers Epoch. Si vous utilisez ce paramètre, il doit toujours être utilisé avec le paramètre "epochEnd". Si elle n'est pas utilisée, la valeur par défaut est celle des dernières 24 heures. |
Têtes
Dans les en-têtes, vous envoyez la clé API à la plateforme Calculus pour authentifier votre appareil authentifier.
|
CalculusApiKey |
Utilisez la clé API que vous avez obtenue à l'étape 1 pour vous authentifier auprès de l'API. |
Modèle JSON
Le cœur de la demande est toujours au format JSON.
3. Utiliser l'API pour publier des données
Le point de terminaison de l'API pour l'envoi de données à notre plateforme est "https://api.calculus.group/General/PostData".
Les appels sont effectués avec l'action HTTP "POST"
Paramètres
|
version de l'api
|
La version de l'API que vous souhaitez appeler la version de l'API que vous souhaitez appeler. La version 1.0 est obsolète, la version 2.0 est actuellement préférée. Utilisez "api-version=2.0". |
Un appel typique serait un POST vers : "https://api.calculus.group/General/PostData?api-version=2.0".
Têtes
Dans les en-têtes, vous envoyez la clé API à la plateforme Calculus pour authentifier votre appareil authentifier.
|
CalculusApiKey |
Utilisez la clé API que vous avez obtenue à l'étape 1 pour vous authentifier auprès de l'API. |
4
.
Modèle JSON
Le cœur de la demande est toujours au format JSON. L'utilisation de "check-deltas" et "reset-deltas" est utilisée lorsque les valeurs peuvent déborder et être remises à 0 lorsque les valeurs peuvent déborder et être remises à 0. Si vous souhaitez obtenir les valeurs cumulées correctes, ceci peut être utilisé pour les calculer dans notre pour les calculer. Veuillez nous contacter pour plus d'informations sur la façon de peut mettre cela en œuvre à l'adresse help@calculus.group.
Les valeurs suivantes peuvent être définies :
|
dispositif |
Nom de l'appareil de la passerelle à laquelle vous souhaitez ajouter des données. S'il n'existe pas, la passerelle sera ajoutée automatiquement. Utilisez le préfixe que nous allons avec la clé API de l'appareil que vous avez choisi, dans le format suivant format suivant : "prefix_gateway". |
||||||
|
horodatage |
Secondes depuis le Jan. 1, 1970 (époque). |
||||||
|
check-delta
|
Actuellement disponible uniquement après avoir marqué un chemin de mesure comme delta. Pour plus d'informations pour plus d'informations à l'adresse help@calculus.group. |
||||||
|
réinitialiser les deltas |
Actuellement disponible uniquement après avoir marqué un chemin de mesure comme delta. Pour plus d'informations pour plus d'informations à l'adresse help@calculus.group. |
||||||
|
mesures |
A tableau de valeurs de mesure que vous souhaitez ajouter. Il peut s'agir d'une valeur, d'une une chaîne de caractères, ou les deux.
|
Exemple d'un corps JSON
{
"dispositif" : "prefix_TestDevice",
"check-deltas" : true,
"reset-deltas" : true,
"timestamp":1573206752,
"mesures" :
[
{
"path" : "measurement_1",
"valeur" : 1
},
{
"path" : "measurement-2",
"stringValue" : "OFF"
},
{
"path" : "temp|measurement.3",
"valeur" : 9.4,
"stringValue" : "BROKEN" (cassé)
},
{
"path" : "temp|measurement.4",
"valeur" : 11.4,
"stringValue" : "OVERLOAD" (surcharge)
}
]
}