Introduction
Learn how to get started with the Passle REST API.
Please be aware that additional properties may be introduced in the future. We strongly advise you to design your code in a manner that allows it to gracefully accommodate any new properties that may be introduced.
API Key
Your API key needs to be included as a header in all requests to our API. The name of the header should be APIKey. Your contact at Passle will be able to provide you with an API key, or alternatively, you can get one by contacting technical support.
When integrating with the Passle API, it's important that the content is fetched server-side, not pulled directly from the API client-side, or your API key will be exposed.
Content search
The GetPosts API endpoint includes a SearchQuery parameter which allows you to search Passle content — this can be useful for adapting your site search to include Passle content.
Rate limiting
Our API is rate limited to 1000 requests per minute (per API key) to avoid being flooded with requests. Responses are cached for 5 seconds via a CDN, so identical requests within 5 seconds of each other won't count towards the rate limit.