Quick start guide

This document is meant for developers who want to use the Basecone API.

Basecone structure

To get a better understanding of the API it's good to know how Basecone is structured. On top is an Office, an Office can have one or more Companies. A Company can be linked to an Accountingsystem. Users are defined at Office level and users can have access to one or more Companies. Documents (for instance an invoice) are owned by a Company and based on a Document a Transaction can be generated.

What you need

In order to use the API you first of all need to have a Basecone APP registration. This can be done here: developers.basecone.com. Additionally you will need to have an Office with at least one Company and one User. If you do not have access to a Basecone Office, you can create a trial account here.

Hello Basecone

To make your first API call you will need to create an API key. With this key you can construct a Basic authorization header that needs to be provided to the server with each request. To make an API key you need a couple of things.

  • ClientId
  • ClientSecret
  • OfficeCode
  • Usercredentials
ClientId and ClientSecret will be provided by Basecone after the registration process is completed.

Step one

Creating an API key is explained here. After this process you will have received an API Key.

Step two

The next step is constructing the Basic authorization header, this is explained in more detail here.

At this stage you are ready to read the first data via the API, a possible first request can look like this:

GET https://api.basecone.com/office
Authorization: Basic ODE1MzhlNmItMmY4NC00YWJiLWFiNjEtNjA3OjRmODRmMTgyLTQ0YWItNGE5OC05NzgwLWQ4OTFhNmIxOTczOQ==
Content-Type: application/json

The result will be returned in JSON format containing the Office code and some additional details.

Example response:

{
    "name": "Basecone12322",
    "code": "basecone"
}

Webhooks

Part of the registration process involves specifying a webhook endpoint. This in an url where Basecone will deliver the webhooks to. Alternatively you can use the webhook subscription API to create or update these subscriptions, please see here. You can find more details on webhooks in general and what sort of webhooks Basecone provides here.