Authentication

Good to know: The auth endpoint will need an API key to generate a token, the publisher admin can get the API key from the Boarda Studio https://studio.boarda.io/settings/publisher

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Admin Console at any time.

Ask one of the admin users to get the API key from the Boarda Admin Console https://studio.boarda.io/settings/publisher

Install the library

The best way to interact with our API is to use one of our official libraries:

Node

# Install via NPM
npm install --save my-api

Python

# Install via pip
pip install --upgrade myapi

Good to know: Using tabs to separate out different languages is a great way to present technical examples or code documentation without cramming your docs with extra sections or pages per language.

Make your first request

To make your first request, send an authenticated request to the pets endpoint. This will create a pet, which is nice.

Get Token

GET https://api.boarda.io/v1/auth

Creates a new pet.

Request Body

Name	Type	Description
apiKey*	string

200 Token generated

{
    token: "<your-token-will-be-here>"
}

401 Permission denied

Good to know: You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.myapi.com/v1/pet  
    -u YOUR_API_KEY:  
    -d name='Wilson'  
    -d species='dog'  
    -d owner_id='sha7891bikojbkreuy'  

Node

// require the myapi module and set it up with your API key
const myapi = require('myapi')(YOUR_API_KEY);

const newPet = away myapi.pet.create({
    name: 'Wilson',
    owner_id: 'sha7891bikojbkreuy',
    species: 'Dog',
    breed: 'Golden Retriever',
})

Python

// Set your API key before making the request
myapi.api_key = YOUR_API_KEY

myapi.Pet.create(
    name='Wilson',
    owner_id='sha7891bikojbkreuy',
    species='Dog',
    breed='Golden Retriever',
)