31:[] 2f:{"title":"API Workflow for partners","cells":[{"id":0,"value":"# API Workflow for partners","pinned":false,"hidden":false,"mode":"md"},{"id":221,"value":"html`

Hello dear partner, and welcome to our API documentation made especially for you.

In this section we will guide you through the process of receiving all the data from your network

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":227,"value":"html`

As for the regular users, the main endpoint is as below:

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":6,"value":"endPoint = \"https://api.sencrop.com/v1\"","pinned":false,"hidden":false,"mode":"ojs"},{"id":321,"value":"contents = html`

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":211,"value":"getTokenTitle = html`

↑ First step: get your token

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":232,"value":"html`

As for the users, you will need to first get your token using your application credentials, if you do not have them, you can reach us at api@sencrop.com and we will be happy to create them for you.

⚠️ Beware that your application credentials are to be kept secret and stored in a safe way. You must not use it your frontend applications. Also note that once issued, we cannot access to your application secret so take care to not loose it. ⚠️

Additionnaly, as a partner, you will benefit from knowing your partner id that we will transmit along with the credentials.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":235,"value":"html`

Once you get your application credentials, you can insert them in the boxes below to try our API right away:

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":129,"value":"viewof applicationId = Inputs.text({\n required: true,\n placeholder: \"application id\",\n width: \"130px\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":132,"value":"viewof applicationSecret = password({\n placeholder: \"application secret\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":240,"value":"html`

Again, as for the users, you will need that token below everytime you want to make a request, and the token expires after a certain delay, so you will want to automatize the token request.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":8,"value":"accessToken = fetch(`${endPoint}/oauth2/token`, {\n body: '{\"grant_type\": \"client_credentials\", \"scope\": \"user\"}',\n headers: {\n Authorization: `Basic ${base64.encode(\n `${applicationId}:${applicationSecret}`\n )}`,\n \"Content-Type\": \"application/json\"\n },\n method: \"POST\"\n})\n .then((response) => {\n return response.json();\n })\n .then((response) => {\n return response.access_token;\n })","pinned":true,"hidden":false,"mode":"ojs"},{"id":266,"value":"getUserInfoTitle = html`

↑ Get your user information

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":270,"value":"html`

If you want to retrieve your partner id or user id, you can run the following command to reach your user profile:

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":274,"value":"userData = fetch(`${endPoint}/me`, {\n headers: {\n Authorization: `Bearer ${accessToken}`\n }\n}).then((response) => {\n return response.json();\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":376,"value":"partnerIds = Object.keys(userData.organisations)","pinned":true,"hidden":false,"mode":"ojs"},{"id":215,"value":"getPartnerDeviceTitle = html`

↑ Look at a partner devices

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":246,"value":"html`

At some point, you will want to know who activated your modules on the Sencrop application and for which devices. You can do so by using the following endpoint, which take the partner id, the number of devices to retrieve and the index in the results:

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":17,"value":"viewof partnerId = Inputs.select(partnerIds, {\n label: \"choose the id of the partner you want to get the data from\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":20,"value":"viewof partnerDevicesLimit = Inputs.select([10, 50, 100], {\n label: \"number devices to retrieve\"\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":28,"value":"viewof partnerDeviceStart = Inputs.select(possibleIndexes, {\n label: \"Start index\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":15,"value":"partnerDevice = fetch(\n `${endPoint}/partners/${partnerId}/devices?limit=${partnerDevicesLimit}&start=${partnerDeviceStart}`,\n {\n headers: {\n Authorization: `Bearer ${accessToken}`\n }\n }\n).then((response) => {\n return response.json();\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":383,"value":"partnerEmails = Object.keys(partnerDevice.users)\n .filter((id) => id != 1 && id != 5)\n .map((id) => {\n return partnerDevice.users[id].contents.email;\n })","pinned":true,"hidden":false,"mode":"ojs"},{"id":278,"value":"delegationTitle = html`

↑ Delegation flows

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":281,"value":"html`

Getting access to device data is done through a delegation mechanism: you have to \"impersonate\" the users to get access to their data. The prerequisite is that the user must have activated at least one of your modules.\nThe following endpoint allows you to create tokens for this impersonation, from the email addresses you got earlier.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":449,"value":"html`

Select below the partner email that you want to get the data from. Please note that you may have only received as a trial stations from Sencrop, and our account cannot be \"impersonated\". If this is the case and you would like to try out some the delegation flow here, please let us know and we will share another station from an account you can impersonate.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":50,"value":"viewof delegationEmailAddress = Inputs.select(partnerEmails, {\n label: \"select the email of the partner you want to get the data from\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":53,"value":"delegationToken = fetch(`${endPoint}/oauth2/token`, {\n body: `{\"grant_type\": \"module\", \"email\": \"${delegationEmailAddress}\", \"scope\": \"user\"}`,\n headers: {\n Authorization: `Basic ${base64.encode(\n `${applicationId}:${applicationSecret}`\n )}`,\n \"Content-Type\": \"application/json\"\n },\n method: \"POST\"\n})\n .then((response) => {\n return response.json();\n })\n .then((response) => {\n return response.access_token;\n })","pinned":true,"hidden":false,"mode":"ojs"},{"id":309,"value":"dataTitle = html`

↑ Access device data

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":313,"value":"html`

From there, use the endpoints as described on the guide to access device data with that delegation token as an access token to \"impersonate\" your users. As an example, we will show you now how to get the data by geolocation from a user

\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":392,"value":"userDataDelegated = fetch(`${endPoint}/me`, {\n headers: {\n Authorization: `Bearer ${delegationToken}`\n }\n}).then((response) => {\n return response.json();\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":407,"value":"userDelegatedId = userDataDelegated.item","pinned":false,"hidden":false,"mode":"ojs"},{"id":411,"value":"userDelegatedDevices = fetch(`${endPoint}/users/${userDelegatedId}/devices`, {\n headers: {\n Authorization: `Bearer ${delegationToken}`\n }\n}).then((response) => {\n return response.json();\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":414,"value":"userDelegatedDevicesIds = userDelegatedDevices.items","pinned":false,"hidden":false,"mode":"ojs"},{"id":418,"value":"viewof delegationDeviceSelected = Inputs.select(userDelegatedDevicesIds, {\n label: \"select the id of the device you want to get the data from\"\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":422,"value":"selectedDeviceLatitude = userDelegatedDevices.devicesStatuses[\n delegationDeviceSelected\n].contents.latitude","pinned":false,"hidden":false,"mode":"ojs"},{"id":424,"value":"selectedDeviceLongitude = userDelegatedDevices.devicesStatuses[\n delegationDeviceSelected\n].contents.longitude","pinned":false,"hidden":false,"mode":"ojs"},{"id":428,"value":"viewof startDateGeo = Inputs.date({\n label: \"The date before which the data starts being retrieved\",\n required: true,\n value: new Date()\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":431,"value":"viewof nbDaysGeo = Inputs.select([7, 30, 60, 90], {\n label: \"number of days to retrieve\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":434,"value":"viewof measuresGeo = Inputs.checkbox(\n [\n \"RELATIVE_HUMIDITY\",\n \"TEMPERATURE\",\n \"TEMPERATURE_MIN\",\n \"TEMPERATURE_MAX\",\n \"LEAF_SENSOR_CONDUCTIVITY\",\n \"RAIN_FALL\",\n \"WIND_SPEED\",\n \"WIND_GUST\",\n \"WIND_DIRECTION\",\n \"LEAF_WETNESS\"\n ],\n { label: \"Measures to retrieve\", value: \"TEMPERATURE\" }\n)","pinned":false,"hidden":false,"mode":"ojs"},{"id":480,"value":"hourlyData = fetch(\n `${endPoint}/users/${userDelegatedId}/devices/${delegationDeviceSelected}/data/hourly?beforeDate=${new Date().toISOString()}&days=1&measures=${\n measuresGeo.length > 0 ? measuresGeo.toString() : \"TEMPERATURE\"\n }`,\n {\n headers: {\n Authorization: `Bearer ${delegationToken}`\n }\n }\n).then((response) => {\n return response.json();\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":389,"value":"html`\n

If you got any issue do not hesitate to contact us at api@sencrop.com and we will sort it out.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":318,"value":"html`

Back to the top ↑

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":126,"value":"base64 = require(\"base-64\")","pinned":false,"hidden":false,"mode":"ojs"},{"id":290,"value":"import { password } from \"@jashkenas/inputs\"","pinned":false,"hidden":false,"mode":"ojs"},{"id":293,"value":"possibleIndexes = {\n let daArray = [];\n for (let i = 0; i < 200; i++) {\n daArray.push(i * partnerDevicesLimit);\n }\n return daArray.filter((amount) => {\n return amount < 1501;\n });\n}","pinned":false,"hidden":false,"mode":"ojs"}],"files":"$W31","stdlib":"1","titling":"auto"}