New API interface

1

First of all, thank you @lubos for the tremendous job done to improve the api. The new interface looks modern, super user friendly and you have went as far as to provide examples on how to call methods. That’s basically spoon-feeding us but that’s much appreciated. :rose::rose::rose:

However, I only noticed this because the index.json have been dropped and my automated flow flopped. :grin: But that’s no big deal. But maybe if this change was announced it would have been a tiny bit better.

Even better, what if we have a separate mega thread on the forum to discuss recent api changes much like how email setup posts work? Preferably before the changes are implemented.

2 Likes
2

I didn’t notice it till your post. I’ll see if it works better with n8n

3

Yes the endpoints have changed. So have the Field Names for all the records. Before they were Snake Case, now they are Camel Case. e.g. custom_field is now CustomField. The uuid endpoints remain the same it seems though.

4

The fields were always in CamelCase/PascalCase format. Never in snake_case.

As for endpoints changing, only one has changed. List of businesses is at /api/index.json instead of /api.json.

1 Like
5

Hi @lubos, It may of been a while back, but some fields (in inventory at least) were snake_case. I noticed that my test script failed to add the data in the changed field names.

Well actually you have removed all /index.json entries. Unfortunately this causes a problem with the single layered uuid’s. for example the following does not have an “Index” entry:

  {
    "Key": "a56e89d1-7bee-4509-8b84-c9ebc3808b0c",
    "Name": "DateAndNumberFormat",
    "Count": 1
  },
 {
    "Key": "ac789d1f-034f-4964-a8b5-ebfffc3511f2",
    "Name": "Tabs",
    "Count": 1
  }

When you navigate down these entries, there is no “Index” with timestamp. You just see the data. Also true for Business details, Logo and others as well.

so https://{{ Domain }}/api/{{ FileID }}/26b9e4a5-ce10-4f30-94c7-23a1ca4428f9.json lists the entries.
such as:

  {
    "Key": "aa45c909-6c00-43f6-ba50-18b960a473f3",
    "Name": "Interest received",
    "Timestamp": 637634774762416300
  },
  {
    "Key": "d7590a2f-e511-4baa-b070-b2250d54e0e2",
    "Name": "Sales",
    "Timestamp": 637634774762416300
  },

However, there is No index (and therefore no Timestamp) for the items mentioned above. They just show the data as in: https://{{ Domain }}/api/{{ FileID }}/a56e89d1-7bee-4509-8b84-c9ebc3808b0c.json

{
  "DateFormat": "MM/dd/yyyy",
  "TimeFormat": "HH:mm:ss",
  "NumberFormat": "CgEuEgEsGAM="
}