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!

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.

Your API Key is visible on the dashboard straight after you register and is also sent to you by email.

Authenticate with API Key

The authentication is done via the POST field APIKey:

Example

# 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 new order, which is nice.

Create new order

POST https://hook.eu1.make.com/b4adevvysv0xy6r9jbfxi5syoqoi3p1x

Creates a new pet.

Request Body

Name	Type	Description
name*	string	The name of the pet
owner_id	string	The id of the user who owns the pet
species	string	The species of the pet
breed	string	The breed of the pet

200 Pet successfully created

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

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 the successful response:

Response

{
    "orderID": "recW8hLxnnjjwuRmv",
    "name": "Name of Recepient",
    "address": "Line 1, Line 2, City, Country",
    "status": "order placed"
}