1. Home
  2. API
  3. Hoe onze API te gebruiken

Hoe onze API te gebruiken

Wat is een API?

De term API staat voor Application Programming Interface (toepassingsprogramma-interface). Het is een communicatieprotocol tussen een client en een server, bedoeld om de uitvoering van elkaars gegevens te vereenvoudigen. De communicatie zal in een bepaald formaat verlopen of een bepaalde actie in gang zetten, zodat zij perfect in elkaars software past.

Een API-sleutelis de unieke identificatie die wordt gebruikt voor de authenticatie van een gebruikerof een programma dat een beroep doet op de API om zijn informatie te delen.


Wat betekent de API voor gebruikers van ons Platform?

Dit betekent dat u de API kunt gebruiken om gemakkelijk gegevens naar ons platform te sturen of van ons platform op te vragen.

Stuur uw eigen gegevens om ze te combineren met de gegevens die al op ons platform staan. Dit kunnen gegevens zijn die afkomstig zijn uit uw ERP- of CRM-systeem, of uit uw sensoren en meetsystemen. U kunt ook gegevens opvragen om in uw eigen toepassing te gebruiken. Dit kunnen metingen of resultaten zijn die door ons platform zijn gemaakt en die u in uw ERP- of CRM-systeem gebruikt.


Hoe gebruik je onze API en API sleutel

  1. Een API-sleutel aanmaken
    Aangezien de API zich in een openbare beta bevindt, moet de API-sleutel worden aangevraagd via e-mail op help@calculus.group . U kunt contact met ons opnemen door een e-mail te sturen met als onderwerp “ Aanvraag API-sleutel voor calculus “. Laat ons in de mail weten voor welk bedrijf je de API key nodig hebt en waar je hem voor gaat gebruiken

    Let op! Als de API sleutel in gevaar zou komen, kunt u ons op hetzelfde adres een e-mail sturen om de sleutel in te trekken.
  2. Gebruik de API om gegevens te verkrijgen
    Met behulp van de API kunt u gegevens opvragen van alle activa die gekoppeld zijn aan het bedrijf waartoe de API-sleutel behoort. Het API-eindpunt dat moet worden gebruikt om gegevens van ons platform op te halen is ” https://api.calculus.group/asset/{key}
    Vervangen {key} door de unieke identifier van het goed.
    De oproepen worden gedaan met de Http-actie “GET”.

    2.1 Vraagparameters
    epochStart


    Het begin van de tijdreeks waarvan u gegevens nodig hebt.
    Het gebruikte datetime formaat is “Epoch”, de Unix Timestamp. Ga naar https://www.epochconverter.com/ voor conversiehulpmiddelen van en naar Epoch.
    Indien gebruikt, altijd gebruiken samen met parameter “epochEnd”.
    Indien niet gebruikt, is de standaard timerreeks de laatste 24 uur.

    epochEnd



    Het einde van de tijdreeks waarvan u gegevens nodig hebt.
    Het gebruikte datetime formaat is “Epoch”, de Unix Timestamp. Ga naar https://www.epochconverter.com/ voor conversiehulpmiddelen van en naar Epoch.
    Indien gebruikt, altijd gebruiken samen met parameter ‘epochStart’.
    Indien niet gebruikt, is de standaard timerreeks de laatste 24 uur.



    2.2 Kopteksten
    In de headers sturen we de API Sleutel naar de cloud om uw toestel te authenticeren.
    CalculusApiKey Gebruik de API sleutel die u in stap 1 kreeg om u te authenticeren bij de API

    2.3 JSON-Model
    De kern van het verzoek wordt geformatteerd in JSON.
  3. Gebruik de API om gegevens te posten
    Het API eindpunt om te gebruiken bij het posten van gegevens naar ons platform is “https://api.calculus.group/General/PostData“. Calls worden gedaan met de Http-actie “POST”.

    2.1 Vraagparameters
    api-versie



    De versie van de API die je wilt bellen, v1.0 is op dit moment verouderd. 2.0 is momenteel de manier om te gaan. Gebruik : api-version=2.0


    Een typische oproep zou een POST oproep zijn naar “https://api.calculus.group/General/PostData?api-version=2.0

    2.2 Kopteksten
    In de headers sturen we de API Sleutel naar de cloud om uw toestel te authenticeren.
    CalculusApiKey Gebruik de API sleutel die u in stap 1 kreeg om u te authenticeren bij de API

    2.3 JSON-Model
    The body of the request is formatted in JSON. Het gebruik van ‘check-deltas‘ en ‘reset-deltas‘ wordt gebruikt wanneer waarden kunnen overlopen en teruggezet worden naar 0. Als u de juiste cumulatieve waarden wilt, kan dit worden gebruikt om deze in onze backend te berekenen. Neem contact met ons op voor meer informatie over hoe u dit kunt implementeren op help@calculus.group .

    De volgende waarden kunnen worden ingesteld:
    apparaat Apparaatnaam van de gateway waaraan u gegevens wilt toevoegen. Als de devicenaam niet bestaat, wordt de gateway automatisch toegevoegd. Gebruik het voorvoegsel dat wij u samen met de API-sleutel voor het door u gekozen apparaat verstrekken, in het volgende formaat:
    prefix_gateway”
    timestamp Seconden sinds 1 januari 1970 (epoche)
    check-deltas
    [Momenteel alleen beschikbaar na het markeren van een meetpad als delta. Neem contact met ons op voor meer informatie op help@calculus.group]
    reset-deltas [Momenteel alleen beschikbaar na het markeren van een meetpad als delta. Neem contact met ons op voor meer informatie op help@calculus.group]
    metingen Een array van meetwaarden die u wilt toevoegen. Dit kan een waarde hebben, een stringwaarde of beide.
    pad string, de meetnaam. Dit zal samen met de apparaatnaam worden gebruikt om het volledige meetpad te vormen. Bijvoorbeeld met een apparaatnaam van “prefix_TestDevice” en een pad van “Testpath” zal het volledige meetpad “prefix_TestDevice|Testpath” zijn voor gebruik in het portaal. Behalve “.”, “_”, “-” en “|” zijn geen spaties of speciale tekens toegestaan.
    waarde dubbel, waarde gerelateerd aan het pad
    stringValuestring, max 50 tekens, waarde met betrekking tot het pad

    Voorbeeld JSON body:
    { "device":"prefix_TestDevice", "check-deltas":true, "reset-deltas":true, "timestamp":1573206752, "measurements":[ { "path": "measurement_1", "value": 1 }, { "path": "measurement-2", "stringValue":"OFF" }, { "path": "temp|measurement.3", "value": 9.4, "stringValue":"BROKEN" }, { "path": "temp|measurement.4", "value": 11.4, "stringValue":"OVERLOAD" } ] } 


Was dit artikel nuttig?

Ondersteuning nodig?
Kunt u het antwoord dat u zoekt niet vinden? Geen nood we zijn er om te helpen!
Vraag om Hulp