Sending requests to the AzoraOne API is how you interact with the service. A request contains headers and (more often than not) a JSON body.


A request URL will look like this:{api}/{version}/{resource}/{identifier}

A request URL might also contain two sets of resources and identifiers:{api}/{version}/{resource}/{identifier}/{resource}/{identifier}

{api} is the short name of your API and can be found under any operation on the API Explorer pages.

Acquiring resources

The HTTP GET method is used for acquiring resources from the API. To get the representation of a specific resource you simply add the identifier to the URL. For example, to retrieve the supplier with ID 12 at company with ID 123 you send a GET request to the following URL:{api}/{version}/companies/123/suppliers/12

Creating resources

The HTTP POST method is used to create new resources. For example, to create a new supplier you send a POST request to the following URL:{api}/{version}/companies/123/suppliers

Most requests to the AzoraOne API will contain resource IDs. According to the RFC1738 specification, only alphanumerics, the special characters “$-_.+!*'(),”, and reserved characters used for their reserved purposes may be used unencoded within a URL. Although safe when used for their defined purpose, reserved characters (; / ? : @ = &) should not be used unencoded for other purposes - including resource IDs. So, when posting new resources, make sure the resource ID only contain safe characters as specified in RFC1738, with no reserved characters present:

Alphanumerics [0-9a-zA-Z], special characters $-_.+!*(),

Resource IDs containing characters not considered safe will generate an error message.

Creating multiple resources

It is possible to submit more than one supplier in a single API call. Compared to multiple requests, a single bulk request can improve your application's performance by decreasing network round trips and increasing throughput. Monitor performance when implementing bulk requests and consider limit your call to 100 or fewer contacts in the beginning. Creating multiple entities via a single request is limited to suppliers in the current API version. In order to create multiple suppliers in a single request you use the following URL:{api}/{version}/companies/123/suppliers/multiple

Updating resources

The HTTP PUT method is used to update existing resources.

Once you have received the response you should control that the resource has actually been updated correctly.

Deleting resources

The HTTP DELETE method is used to delete existing resources. Add the identifier to the URL to delete that resource.

Date formatting

Parameters like invoiceDate are using the ISO-8601 format:

Date: 2020-09-02

Date and time: 2020-09-02 08:30:00