API
Developers
Connect your own application with the printer data and update it in real time with the database API.
API
You can use a web service to extract the data from your application. We can set up a specific query for you so that you can extract the data you need.
MySQL
You can directly access the MySQL database (MariaDB). We will give you access and support to make any queries. You can also write a flag state to some tables.
API to do pulling against database.
GET / Last meter readings from all printers.
Variables
| Field |
Description | Example |
|---|---|---|
| IP /Domain |
Subdomain or IP address |
https://app.ameterreading.com/web_app/api_v1/ |
| Query name |
Query name which has associated a MySQL query and the output file format. Any other query with less or more fields of the database can be made under request. |
meters_json.php |
| Token ID |
It's an ID to identify the user. Is associated to a license. It also can be associated to a client code and install code. |
?token=453FF0945D20D3F8416FF81163394BD0 |
| Client code |
Client code. When the token does not have a customer associated by default, the data of all customers can be captured with the same token. If a client code is indicated in the link, only the devices that corresponds to said client will be listed. If this value is missing or blank, all printers will be listed. |
&code=test_1234 |
| Install code |
Installation code. It works the same as the client code. The same client can have several installation sites. Indicating the installation code, only the printers corresponding to it will appear. This would be the case of a client with several locations. |
&codinstall=FA-16-3E-B1-A7-EE |
Output fields as a sample
| Field |
Description | Example |
|---|---|---|
| iKey |
Unique ID of the printer | ZCZBBJCG6001FJW-ci-FA-16-3E-B1-A7-EE |
| Install |
Installation code |
FA-16-3E-B1-A7-EE |
| Icon |
Icon associated |
0 |
| Billable | Printer under contract / billable | on |
| Code |
Client code | 865975 |
| Date |
Datetime format |
2020-10-26 09:21:05 |
| Serial |
Printer serial number |
ZCZBBJCG6001FJW |
| Alias |
Printer alias |
Any number or name |
| Model |
Printer model |
KONICA MINOLTA bizhub C250i |
| BW |
Black print meter reading / page count. |
9999 |
| Color |
Color print meter reading / page count |
9999 |
| Total |
Total count meter reading / page count |
9999 |
| A3_BW |
Black A3 / large meter reading / page count |
9999 |
| A3_Color |
Color A3 / large meter reading / page count |
9999 |
| Scans |
Scanner page count |
9999 |
| Status |
Status of the printer. OK it's reporting | 9999 |
| Location |
Location of the printer within the client site. ( Workshop, Front desk, etc) | 9999 |
| K |
Black level |
0 |
| C |
Cyan level |
10 |
| M |
Magenta level |
50 |
| Y |
Yellow level |
100 |
Example code
Format: Specific URL+ SQL query ID + token ID
Example explained: “https://app.ameterreading.com/web_app/api_v1/" + "meters_json.php" + "?token=453FF0945D20D3F8416FF81163394BD0” + "&code=test_1234" + "&codinstall=FA-16-3E-B1-A7-EE"
Test URL ( 1 token per client )
https://app.ameterreading.com/web_app/api_v1/meters_json.php?token=453FF0945D20D3F8416FF81163394BD0
Test URL ( 1 token for all clients )
Example output code (json)
{"total":2,"rows":[
{"iKey":"9C-32-CE-01-48-85-ci-F4-B7-E2-8E-AE-E9","Install":"F4-B7-E2-8E-AE-E9","Icon":"","Billable":"on","Code":"CL-7787","Date":"2020-09-15 16:23:26","Serial":"2GE03028","Alias":"","Model":"Canon iR-ADV C3525 III 11.20","BW":"5760","Color":"3470","Total":"9279","A3_BW":"8","A3_Color":"41","Scans":"1295","Status":"OK","Location":null,"K":"16","C":"1","M":"1","Y":"1"},
{"iKey":"JWF60669-ci-00-16-44-D5-F4-2D","Install":"00-16-44-D5-F4-2D","Icon":"","Billable":"on","Code":"7654321","Date":"2020-10-22 10:13:38","Serial":"JWF60669","Alias":"","Model":"Canon iR-ADV C5235 46.68","BW":"42055","Color":"95454","Total":"144450","A3_BW":"657","A3_Color":"6284","Scans":"18201","Status":"OK","Location":"","K":"82","C":"10","M":"19","Y":"5"}
]}