Name: zevvy AG
Price range: $

1.0 Authentication

The zevvy API supports the flows "authorization_code" and "device". The "device flow" is typically used for mobile or embedded applications, while the "authorization_code flow" is used for web applications.

For our application, the "device flow" is usually used.

The following data are required for successful authentication:

client_id
client_secret

(If you do not yet have a Client ID, you can contact us for the creation of the Client ID)

You will then receive a response with the following data:

device_code
user_code
client_secret
verification_uri
verification_uri_complete
interval

Code Example

java python javascript shell php

														import okhttp3.OkHttpClient;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class Main {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient().newBuilder()
          .build();
        MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
        RequestBody body = RequestBody.create(mediaType, "client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&scope=measurement register device offline_access");
        Request request = new Request.Builder()
          .url("https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/auth/device")
          .method("POST", body)
          .addHeader("Content-Type", "application/x-www-form-urlencoded")
          .build();

        try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

														                                

													

														import http.client

conn = http.client.HTTPSConnection("iam.zevvy.org")
payload = 'client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&scope=measurement%20register%20device%20offline_access'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/realms/zevvy-prod/protocol/openid-connect/auth/device", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

														                                

													

														var settings = {
  "url": "https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/auth/device",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/x-www-form-urlencoded"
  },
  "data": {
    "client_id": "<CLIENT_ID>",
    "client_secret": "<CLIENT_SECRET>",
    "scope": "measurement register device offline_access"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

														                                

													

														wget --no-check-certificate --quiet \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --body-data 'client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&scope=measurement%20register%20device%20offline_access' \
   'https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/auth/device'

														                                

													

														<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/auth/device',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&scope=measurement%20register%20device%20offline_access',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


														                                

													

Response

json

1.2 Generate access token

To retrieve an access token, you need to send a request with the following details from the previous request:

device_code
client_id
client_secret

In addition, you must specify the scope and grant_type.

Here are the available scopes:

offline_access: Required for the refresh token to have a longer validity duration for long-term use.
measurement: Required for managing measurements.
register: Required for managing registers.
device: Required for managing devices.

Make sure to correctly include these details in your request in order to obtain a valid access token.

Code Example

java python javascript shell php

														import okhttp3.OkHttpClient;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import okhttp3.Request;
import okhttp3.Response;

public class Main {
    public static void main(String[] args) {
		OkHttpClient client = new OkHttpClient().newBuilder()
		.build();
		MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
		RequestBody body = RequestBody.create(mediaType, "client_id=<CLIENT_ID>&grant_type=urn:ietf:params:oauth:grant-type:device_code&client_secret=<CLIENT_SECRET>&device_code=<DEVICE_CODE>&scope=measurement register device offline_access");
		Request request = new Request.Builder()
			.url("https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/token")
			.method("POST", body)
			.addHeader("Content-Type", "application/x-www-form-urlencoded")
			.addHeader("Cookie", "AWSALB=k/cVRilmdofo5OtWeHNok/wUnw6bThROPdmBlVGb6bixazTswvLUEHyPwBW7JryCpAfiCzZ6QFWEIDCsyM0bnj7W+dGoVPtBZL0PHdIEd9OH6EDuycxA+f2Pubx5; AWSALBCORS=k/cVRilmdofo5OtWeHNok/wUnw6bThROPdmBlVGb6bixazTswvLUEHyPwBW7JryCpAfiCzZ6QFWEIDCsyM0bnj7W+dGoVPtBZL0PHdIEd9OH6EDuycxA+f2Pubx5")
			.build();

		try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

														                                

													

														import http.client

conn = http.client.HTTPSConnection("iam.zevvy.org")
payload = 'client_id=<CLIENT_ID>&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code&client_secret=<CLIENT_SECRET>&device_code=<DEVICE_CODE>&scope=measurement%20register%20device%20offline_access'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/realms/zevvy-prod/protocol/openid-connect/token", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

														                                

													

														var settings = {
  "url": "https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/token",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/x-www-form-urlencoded",
    "Cookie": "AWSALB=k/cVRilmdofo5OtWeHNok/wUnw6bThROPdmBlVGb6bixazTswvLUEHyPwBW7JryCpAfiCzZ6QFWEIDCsyM0bnj7W+dGoVPtBZL0PHdIEd9OH6EDuycxA+f2Pubx5; AWSALBCORS=k/cVRilmdofo5OtWeHNok/wUnw6bThROPdmBlVGb6bixazTswvLUEHyPwBW7JryCpAfiCzZ6QFWEIDCsyM0bnj7W+dGoVPtBZL0PHdIEd9OH6EDuycxA+f2Pubx5"
  },
  "data": {
    "client_id": "<CLIENT_ID>",
    "grant_type": "urn:ietf:params:oauth:grant-type:device_code",
    "client_secret": "<CLIENT_SECRET>",
    "device_code": "<DEVICE_CODE>",
    "scope": "measurement register device offline_access"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

														                                

													

														wget --no-check-certificate --quiet \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --body-data 'client_id=<CLIENT_ID>&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code&client_secret=<CLIENT_SECRET>&device_code=<DEVICE_CODE>&scope=measurement%20register%20device%20offline_access' \
   'https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/token'

														                                

													

														<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://iam.zevvy.org/realms/zevvy-prod/protocol/openid-connect/token',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'client_id=<CLIENT_ID>&grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code&client_secret=<CLIENT_SECRET>&device_code=<DEVICE_CODE>&scope=measurement%20register%20device%20offline_access',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


														                                

													

Response

json

2.0 Create a device in zevvy

With the token from the previous step (<LONG_ACCESS_TOKEN>), the API can now be used, for example, to create a device.

Only the following data need to be sent to the endpoint:

Access Token
Name
Reference (optional)

Please note that the access token is placed in the header and the name (Name) and reference (Reference) should be included as JSON in the body.

Code Example

java python javascript shell php

														import okhttp3.OkHttpClient;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import okhttp3.Request;
import okhttp3.Response;

public class Main {
    public static void main(String[] args) {
		OkHttpClient client = new OkHttpClient().newBuilder()
		.build();
		MediaType mediaType = MediaType.parse("application/json");
		RequestBody body = RequestBody.create(mediaType, "{\r\n    \"name\": \"Mein neues Gerät\",\r\n    \"reference\": \"reference_001\"\r\n}");
		Request request = new Request.Builder()
			.url("https://api.zevvy.org/devices")
			.method("POST", body)
			.addHeader("Content-Type", "application/json")
			.addHeader("Authorization", "Bearer <LONG_ACCESS_TOKEN>")
			.build();

		try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

														                                

													

														import http.client
import json

conn = http.client.HTTPSConnection("api.zevvy.org")
payload = json.dumps({
  "name": "Mein neues Gerät",
  "reference": "reference_001"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <LONG_ACCESS_TOKEN>'
}
conn.request("POST", "/devices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

														                                

													

														var settings = {
  "url": "https://api.zevvy.org/devices",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer <LONG_ACCESS_TOKEN>"
  },
  "data": JSON.stringify({
    "name": "Mein neues Gerät",
    "reference": "reference_001"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

														                                

													

														wget --no-check-certificate --quiet \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <LONG_ACCESS_TOKEN>' \
  --body-data '{
    "name": "Mein neues Gerät",
    "reference": "reference_001"
}' \
   'https://api.zevvy.org/devices'

														                                

													

														<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.zevvy.org/devices',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "name": "Mein neues Gerät",
    "reference": "reference_001"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer <LONG_ACCESS_TOKEN>',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


														                                

													

Response

json

3.0 Example: Charging station with 15-minute values

In the previous example, we looked at how individual devices can be opened in zevvy via API. However, with large volumes of data, it is advantageous if the devices do not have to be created with individual API connections.

Our API automatically detects whether a device or register exists or not. If not, the device or register is automatically created.

For this, we use the "_bulk_create" endpoint.

The following is needed:

deviceName
registerName

In the example, we use the following values:

deviceName: zevvy Test Device Example Charging Station
registerName: zevvy Test Register Example Charging Station

Since the device and the register do not yet exist, the API will automatically create both and import the data sent with them.

After import, the devices and registers can be viewed in zevvy and assigned to a measurement point. (See video)

Code Example

java python javascript shell php

														import okhttp3.OkHttpClient;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import okhttp3.Request;
import okhttp3.Response;

public class Main {
    public static void main(String[] args) {
		OkHttpClient client = new OkHttpClient().newBuilder()
		.build();
		MediaType mediaType = MediaType.parse("application/json");
		RequestBody body = RequestBody.create(mediaType, "[\r\n   {\r\n     \"value\": 690.0,\r\n     \"readAt\": \"2023-05-30T04:00:00\"\r\n   },\r\n   {\r\n     \"value\": 691.2,\r\n     \"readAt\": \"2023-05-30T04:15:00\"\r\n   },\r\n   {\r\n     \"value\": 691.5,\r\n     \"readAt\": \"2023-05-30T04:30:00\"\r\n   },\r\n   {\r\n     \"value\": 691.6,\r\n     \"readAt\": \"2023-05-30T04:45:00\"\r\n   },\r\n   {\r\n     \"value\": 691.6,\r\n     \"readAt\": \"2023-05-30T05:00:00\"\r\n   },\r\n   {\r\n     \"value\": 691.7,\r\n     \"readAt\": \"2023-05-30T05:15:00\"\r\n   }\r\n  ]");
		Request request = new Request.Builder()
			.url("https://api.zevvy.org/deviceRef/{deviceReference}/registerRef/{registerReference}/measurements/_bulk_create")
			.method("POST", body)
			.addHeader("Content-Type", "application/json")
			.build();

		try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

														                                

													

														import http.client
import json

conn = http.client.HTTPSConnection("api.zevvy.org")
payload = json.dumps([
  {
    "value": 690,
    "readAt": "2023-05-30T04:00:00"
  },
  {
    "value": 691.2,
    "readAt": "2023-05-30T04:15:00"
  },
  {
    "value": 691.5,
    "readAt": "2023-05-30T04:30:00"
  },
  {
    "value": 691.6,
    "readAt": "2023-05-30T04:45:00"
  },
  {
    "value": 691.6,
    "readAt": "2023-05-30T05:00:00"
  },
  {
    "value": 691.7,
    "readAt": "2023-05-30T05:15:00"
  }
])
headers = {
  'Content-Type': 'application/json',
}
conn.request("POST", "/deviceRef/{deviceReference}/registerRef/{registerReference}/measurements/_bulk_create", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

														                                

													

														var settings = {
  "url": "https://api.zevvy.org/deviceRef/{deviceReference}/registerRef/{registerReference}/measurements/_bulk_create",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
  },
  "data": JSON.stringify([
    {
      "value": 690,
      "readAt": "2023-05-30T04:00:00"
    },
    {
      "value": 691.2,
      "readAt": "2023-05-30T04:15:00"
    },
    {
      "value": 691.5,
      "readAt": "2023-05-30T04:30:00"
    },
    {
      "value": 691.6,
      "readAt": "2023-05-30T04:45:00"
    },
    {
      "value": 691.6,
      "readAt": "2023-05-30T05:00:00"
    },
    {
      "value": 691.7,
      "readAt": "2023-05-30T05:15:00"
    }
  ]),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

														                                

													

														wget --no-check-certificate --quiet \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/json' \
  --body-data '[
   {
     "value": 690.0,
     "readAt": "2023-05-30T04:00:00"
   },
   {
     "value": 691.2,
     "readAt": "2023-05-30T04:15:00"
   },
   {
     "value": 691.5,
     "readAt": "2023-05-30T04:30:00"
   },
   {
     "value": 691.6,
     "readAt": "2023-05-30T04:45:00"
   },
   {
     "value": 691.6,
     "readAt": "2023-05-30T05:00:00"
   },
   {
     "value": 691.7,
     "readAt": "2023-05-30T05:15:00"
   }
  ]' \
   'https://api.zevvy.org/deviceRef/{deviceReference}/registerRef/{registerReference}/measurements/_bulk_create'

														                                

													

														<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.zevvy.org/deviceRef/{deviceReference}/registerRef/{registerReference}/measurements/_bulk_create',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'[
   {
     "value": 690.0,
     "readAt": "2023-05-30T04:00:00"
   },
   {
     "value": 691.2,
     "readAt": "2023-05-30T04:15:00"
   },
   {
     "value": 691.5,
     "readAt": "2023-05-30T04:30:00"
   },
   {
     "value": 691.6,
     "readAt": "2023-05-30T04:45:00"
   },
   {
     "value": 691.6,
     "readAt": "2023-05-30T05:00:00"
   },
   {
     "value": 691.7,
     "readAt": "2023-05-30T05:15:00"
   }
  ]',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


														                                

													

Response

json

1.0 Authentication

Code Example

Response

1.2 Generate access token

Code Example

Response

2.0 Create a device in zevvy

Code Example

Response

3.0 Example: Charging station with 15-minute values

Code Example

Response

API Feedback

Software

Help Center

Settlements

About us

1.0 Authentication

Code Example

Response

1.2 Generate access token

Code Example

Response

2.0 Create a device in zevvy

Code Example

Response

3.0 Example: Charging station with 15-minute values

Code Example

Response

API Feedback

Newsletter

Cookie settings