Getting Started

Getting started with Xenia's API

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 Dashboard at any time.

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 xenia

Python

# Install via pip
pip install --upgrade xenia

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.

Create a new location

POST https://api.xenia.team/v1/locations

Create new location

Headers

Name	Type	Description
Authorization*	JWT Token	Access token

Request Body

Name	Type	Description
name*	string	The name of location
description	string
parentId	string	id of parent location

200 Success

{
    "id": "e77b6442-de60-401c-a173-0afc84a5747e",
    "name": "Main Branch",
    "description": "",
    "parentId": "",
    "createdAt": 1701743645
    "updatedAt": 2001743645
}

401 Permission denied

400: Bad Request Validation failed

500: Internal Server Error Something went wrong

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

curl

curl https://api.xenia.com/v1/locations  
    -u YOUR_API_KEY:  
    -d name='Hightstreet Branch'  

Node

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

const newLocation = await xenia.location.create({
    name: 'Hightstreet Branch',
})

Python

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

xenia.Location.create(
    name='Hightstreet Branch'
)