Conventions.

In the guides you will see curl commands as examples on how to call the API from the command prompt. These commands will use placeholders where is expected that you provide some custom value pertinent to your account.

Placeholders

Placeholders are strings surrounded by mustaches as: {{placeholder-name}}

For example this command is used to load stations for a given account:

curl --request GET \
  --url https://api.betterez.com/inventory/stations \
  --header 'x-api-key: {{x-api-key}}' \
  --header 'authorization: Bearer {{jwt-short-token}}'

Notice that we have 2 placeholders in here; {{{x-api-key}} and {{jwt-short-token}}.

As an example; if the public key was kjfaC9807FDccsafa908 and the jwt short token was asdjncalksufnpw8nrnpwiufywrqjr061nvuyrqbfllwlunwecfjaFLURQ===QD the command you will run in your console once the placeholders are replaced with the real values will look like this:

curl --request GET \
  --url https://api.betterez.com/inventory/stations \
  --header 'x-api-key: {{kjfaC9807FDccsafa908}}' \
  --header 'authorization: Bearer asdjncalksufnpw8nrnpwiufywrqjr061nvuyrqbfllwlunwecfjaFLURQ===QD'

Query string parameters

Make sure to URLEncode all query string parameters before submitting a request.

Query string parameters that accept 'arrays'

From time to time some query string parameters will accept and array of values, example: providerIds

In those cases you can always pass one or more values and each values are separated by commas without spaces.

Ex: ?providerIds=56cf146a7dfdeb5608000215,50fd5830a09dd1af170000ee and ?providerIds=56cf146a7dfdeb5608000215 are both valid.

OperationID

The operationId is a client generated UUID. It's used to group a series of items added to the cart together. It's important to pass a different operationId for each group if items added to the cart to be able to edit the cart.