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 will be sent to you by the team.

Make your first request

To make your first request, send an authenticated request to the products endpoint. This will generate a json with all products, which is nice.

Test API Key

GET https://vendmy.com/api/hello/world

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

Take a look at how you might call this method using curl:

curl

curl --location --request GET 'https://vendmy.com/api/hello/world.php' \
    --header 'Authorization: Bearer {your-api-key}' \
    --data-raw ''

PHP - cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://vendmy.com/api/hello/world.php',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer {your-api-key}',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

import http.client

conn = http.client.HTTPSConnection("vendmy.com")
payload = ''
headers = {
  'Authorization': 'Bearer {your-api-key}'
}
conn.request("GET", "/api/hello/world.php", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Two things can be displayed

// It works -> Go to the next session
Hello World

// Error(s) -> Your API Key isn't valid
API Key error