[LEGACY] Public API Reference

The Rest API allows you to build a highly custom paid-membership program on your Shopify storefront.

NOTE: With the release of Public API v2, Public API v1 will be sunset in May of 2024!

Find the v2 reference here.

Authentication

API Keys are private and should not be shared or exposed on the front end.

Using API Key in Requests

Include your API key as an X-Inveterate-Api-Key header on all API endpoint requests.

Requirements

All API requests utilize https://public.inveterateapi.com/ as the base URL.

Example Get Request

curl -X GET "https://public.inveterateapi.com/merchant"
-H "X-Inveterate-Api-Key: {api_key}"

const merchant = await fetch('https://public.inveterateapi.com/merchant', {
  headers: {
    'Content-Type': 'application/json',
    'X-Inveterate-Api-Key': '{api_key}',
  },
  method: 'GET',
}).then(data => data.json());

Reference Shortcuts

Benefits API Campaigns API Customers API Merchant API Webhooks Free tiers API

PreviousSchemas NextBenefits API

Last updated 2 years ago

Was this helpful?

hashtagNOTE: With the release of Public API v2, Public API v1 will be sunset in May of 2024!

hashtagAuthentication

hashtagUsing API Key in Requests

hashtagRequirements

hashtagExample Get Request

hashtagReference Shortcuts

NOTE: With the release of Public API v2, Public API v1 will be sunset in May of 2024!

Authentication

Using API Key in Requests

Requirements

Example Get Request

Reference Shortcuts