There is one environment, and that is worth knowing up front
Tagsight does not run a separate sandbox you can point a test suite at. Your integration team works against the same service your engineers use.
We would rather say that plainly than describe an environment that does not exist. What replaces it is a convention that works, costs nothing, and takes about five minutes to set up.
The convention
One workspace, used by nobody but the integration.
Create a workspace in your organization named for what it is, Integration sandbox or similar, and treat it as disposable. Nothing your engineers rely on ever lives in it. Anything in it can be deleted without asking anybody.
This gives you three things a separate environment would have given you:
- Blast radius. A script with a bug deletes drawings in one workspace that nobody is using, and reaches nothing else.
- A clean read. Your test assertions are not disturbed by an engineer uploading a revision while your suite runs.
- An honest bill. Usage from the sandbox is visible separately from real work.
The key
Mint a key scoped to read only, and use it for everything your integration does until the moment you are deliberately testing submission.
A read-only key can poll and fetch. It cannot submit a drawing, so a loop with a bug in it cannot spend your allowance while nobody is watching. That is the failure most integrations have at least once, and it is the one worth designing out.
When you do need to test submission, mint a second key with extract, use it only in the tests that need it, and keep it out of the code path your polling runs on.
Keys are created under your account settings. A key is shown once, when it is created, and never again. Keys are scoped to your organization, so rotating one does not disturb anybody else's.
Watch what it costs
Submitting a drawing consumes from the same allowance real work does. There is no free tier for testing and there is no separate meter.
Two things worth doing before your first automated run:
- Use a small file. A one page drawing tests every part of the flow that a two hundred page set does, at a fraction of the cost.
- Test your polling against a drawing that is already finished, rather than submitting a new one each time. Most integration bugs are in the polling and the parsing, not in the submission.
If you are on a contracted allowance, your administrator can see what has been used at any time, and the billing contact receives a summary each month.
Deleting it afterwards
Delete the workspace when the integration is live. A disposable workspace nobody has deleted becomes a workspace somebody eventually puts something real in, and then it is no longer disposable.
Related
- The API reference has the endpoints, the rate limits, the error codes, and the fixed address we deliver webhooks from, which matters if your firewall only accepts named sources.
- Your administrator can restrict which networks reach your organization at all. Do that after your integration is working, not before, or you will spend an afternoon debugging the wrong thing.