Get started

Before you start

You will need to sign up for a Betterez account.

Once you have an account you will need your public and private api keys to make requests to the end points of the Betterez API.

API structure

Betterez API is modeled as a series of buckets of resources based on how the api is normally used.

For example:

  • Sales Bucket: contains the resources required to interact with our shopping cart.
  • Inventory Bucket: contains the resources required to browse products.

You will normally interact with resources in multiple buckets to perform complex operations, like selling a ticket.

You can see a list of buckets in the API Documentation

Versioning

Betterez API goal is to be backward compatible.

We follow the expand contract pattern to always add new fields into resources and rarely remove existing fields.

On rare occasions, we may deprecate resources and replace those resources with new ones if the required changes are not backward compatible.

In those cases we will always keep a window where both resources are available.

Resources

Resources represent specific items that can be manipulated and inspected based on the different permissions.

You can use HTTP verbs (GET, POST, PUT, PATCH, DELETE) to perform actions on the resources.

Authentication

All endpoints use SSL (https).

There are 3 different authentication mechanism used when consuming the api.

  • X-API-KEY header for non-destructive public end points.
  • Basic authentication: to log into an account and request the JWT token
  • JWT token: for more sensitive endpoints

Useful tools

You should be able to interact with Betterez endpoints using a tool like curl or postman

Next

You should consult our guides