Resources
Postman collection
Every endpoint of the API as a ready-to-run Postman collection, generated from the contract, with example requests and responses.
Download the collection (Postman collection format v2.1) and import it in Postman with Import → File. It has a folder per area of the API and a request per endpoint, each with an example body and an example response.
Set it up
- Open the collection's Variables tab.
- Paste your API key into the Current value of
apiKey. Current values stay on your machine and are not synced or exported with the collection. - Leave
baseUrlashttps://api.trovacast.comunless we gave you another environment. - Send Introspection → Get me to check the key.
- The collection authenticates every request as
Authorization: Bearer {{apiKey}}. - Every write sends a fresh
Idempotency-Key({{$guid}}). To retry one request safely, replace it with a fixed value and send it again. - Path variables such as
:contactIdhold placeholders (CONTACT_ID): fill in your own ids under the request's Params. Optional query parameters are listed but switched off.
Keeping it current
The collection is regenerated from GET /v1/openapi.json whenever the API changes, together with the reference and the SDKs. Import it again to pick up new endpoints; see the changelog for what changed.