All pages
Powered by GitBook
2 of 9

Admin

Our admin endpoints.

Benefits

This set of benefit endpoints should only be used by merchant that have Tiers disabled. Benefit access for merchants that have enabled Tiers can be found in the Tiers tab in this API reference.

Members

Member accessing and altering endpoints.

get

Returns all members for a given merchant. Merchant is pulled from the public API key for security reasons.

Pagination is supported by passing limit and lastCustomerId values as
query parameters. You will get a lastCustomerId value in the response
of the previous request, which can be used for the next.
Query parameters
limitstringrequired
lastCustomerIdstringrequired
Header parameters
X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses
curl -L \
  --url '/v2.0/admin/members?limit=text&lastCustomerId=text' \
  --header 'X-Inveterate-Api-Key: text'
{
  "message": "text",
  "data": {}
}

Returned upon successful direct action to our database. Action is immediate.

get

Returns a single member for a given merchant. Merchant is pulled from the public API key for security reasons.

Path parameters
idstringrequired

The customer ID number which you would like to retrieve.

Header parameters
X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses
curl -L \
  --url '/v2.0/admin/members/{id}' \
  --header 'X-Inveterate-Api-Key: text'
{
  "message": "text",
  "data": {}
}

Returned upon successful direct action to our database. Action is immediate.

Credits

Get and create credit requests.

Merchant

Get your merchant data. Serves as a good health check for our services and your API key/access.

Tiers

These endpoints only work for merchants with tiers enabled. Access benefits via this set of endpoints.

Benefits

Campaigns

Webhooks

Get, create and delete webhooks. Use these to build third-party integrations.

get

Returns all webhooks for a given merchant. Merchant is pulled from the public API key for security reasons.

Header parameters
X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses
curl -L \
  --url '/v2.0/admin/webhooks' \
  --header 'X-Inveterate-Api-Key: text'
{
  "message": "text",
  "data": {}
}

Returned upon successful direct action to our database. Action is immediate.

post

Generates a security token and places an entry with the token and the callback URL in our backend. The token is used to verify that the request is coming from Inveterate within your app, when the callback URL is triggered. Ensure that you save the token.

The callback URL will be triggered when one of the following events occurs:

`merchant.updated`
`merchant.reinstall`
`customer.created`
`customer.updated`
`customer.credits.updated`
`customer.ordered`
`customer.cancellation_requested`
`customer.confirmed_cancellation`
Header parameters
X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses
curl -L \
  --request POST \
  --url '/v2.0/admin/webhooks' \
  --header 'X-Inveterate-Api-Key: text'
{
  "message": "text",
  "data": {}
}

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

delete

Deletes a webhook for a given merchant. Merchant is pulled from the public API key for security reasons. The effects of this method are both immediate (data deleted from webhooks database) and eventual (request against backend service to confirm webhook deletion).

Header parameters
X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses
curl -L \
  --request DELETE \
  --url '/v2.0/admin/webhooks' \
  --header 'X-Inveterate-Api-Key: text'
{
  "message": "text",
  "data": {}
}

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.