Quick Start
Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!
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.
The best way to interact with our API is to use one of our official libraries:
Node
Python
# Install via NPM
npm install --save my-api
# 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.
To make your first request, send an authenticated request to the pets endpoint. This will create a
pet, which is nice.post
https://api.myapi.com/v1
/pet
Create pet.
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
Node
Python
curl https://api.myapi.com/v1/pet
-u YOUR_API_KEY:
-d name='Wilson'
-d species='dog'
-d owner_id='sha7891bikojbkreuy'
// 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',
})
// 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',
)
Last modified 1yr ago