\r\n Welcome to SalenGo’s Web API v2! This API is RESTful, fully featured, easy to integrate with.\r\n
\r\n\r\nThe SalenGo API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\r\nThe SalenGo API differs for every account as we release new versions and tailor functionality. Log in to see docs customized to your version of the API, with your test key and data.
\r\nSubscribe to SalenGo's API announce mailing list for updates.
\r\n\r\n To make integrating with the SalenGo API easier we've made a Postman collection that you can populate with your own application credentials and environment variables.\r\n
\r\nThe collection is publicly available at: https://api.salengo.com
\r\n\r\n The base URLs for the SalenGo API are\r\n - https://api.salengo.com.com/v2/ for live\r\n
The SalenGo API uses API keys to authenticate requests. You can view and manage your API keys in SalenGo Account Settings.
\r\nYou can use restricted API keys for granular permissions.
\r\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\r\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\r\n\r\n\r\nThere are two required headers:
\r\nContent-Type: application/jsonAuthorization: Bearer \r\n All requests and responses are JSON-formatted and UTF-8 encoded.\r\n
Accept: application/jsonA Content-Type and Content-Length header must be given when sending data to the API (using POST and PUT endpoints)
\r\n Content-Type: application/json\r\nContent-Length: 3495\r\n| Verb | \r\nDescription | \r\n
|---|---|
| GET | \r\nRetrieve a resource or group of resources | \r\n
| POST | \r\nCreate a new resource | \r\n
| PUT | \r\nUpdate an existing resource | \r\n
| DELETE | \r\nDelete an existing resource | \r\n
| OPTIONS | \r\nView allowed verbs against a specific resource | \r\n
| 200 - OK | Everything worked as expected. |
|---|---|
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 402 - Request Failed | The parameters were valid but the request failed. |
| 403 - Forbidden | The API key doesn't have permissions to perform the request. |
| 404 - Not Found | The requested resource doesn't exist. |
| 406 - Not Acceptable | Missing Accept header. For example: Accept: application/json |
| 409 - Conflict | The request conflicts with another request (perhaps due to using the same idempotent key). |
| 429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 - Server Errors | Something went wrong on SalenGo's end. (These are rare.) |
All calls within the Web API are allotted a specific number of requests per refresh period.
\r\nEach Web API request returns the following header information regarding rate limits and number of requests left.
\r\nDepending on the endpoint you are trying to reach, it will have a specific number of allowed requests per refresh period. Once this threshold has been reached, we will return a status code 429 response.
When You Reach a Rate Limit : You will no longer be able to make request against that endpoint for the duration of that refresh period.\r\n\r\n
\r\n All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list charges, list customers, and list documents.\r\n These list API methods share a common structure, taking at least these two parameters: perpage and page.\r\n
\r\n SalenGo utilizes cursor-based pagination via the perpage and page parameters.\r\n Both parameters take an existing object ID value (see below) and return objects in reverse chronological order.\r\n
\r\n When we make backwards-incompatible changes to the API, we release new, numbered versions. \r\n The current version is 2.\r\n \r\n Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.\r\n
\r\n\r\nAll requests will use your account API settings, unless you override the API version. The changelog lists every available version. Note that events generated by API requests will always be structured according to your account API version.
\r\nAll timestamps are formatted as ISO8601 with timezone information. For API calls that allow for a timestamp to be specified, we use that exact timestamp. These timestamps look something like 2014-02-27T15:05:06.123Z.
\r\nSpecifies a rounding behavior for numerical operations capable of discarding precision. Each rounding mode indicates how the least significant returned digit of a rounded result is to be calculated.
\r\nenum=0enum=3 with with precision xenum=1 with with precision xenum=2 with with precision x