Environments
Base URLs
Section titled “Base URLs”Your workspace is part of the URL. {workspace} is the subdomain you sign in with.
| Environment | Base URL | Who uses it |
|---|---|---|
| Production | https://{workspace}.api.bytephase.com/api |
Everyone |
| Staging | https://{workspace}.api.bytephaserecovery.com/api |
BytePhase’s own team and plugin developers working with us |
| Local development | http://{workspace}.localhost:81/api |
BytePhase engineers running the platform locally |
| White-label custom domain | https://{custom_domain}/api |
Workspaces on their own domain |
All paths in this documentation are relative to the base URL. For example POST /api/integrations/leads on workspace harbor-repair is:
POST https://harbor-repair.api.bytephase.com/api/integrations/leadsThe API reference lets you pick the environment and fill in the workspace once; every example and every “Try it” request then uses it.
White-label domains
Section titled “White-label domains”If your workspace runs on your own domain — you sign in at repairs.example.com rather than something.bytephase.com — the API is at that domain too:
https://repairs.example.com/api/integrations/pingDo not use api.bytephase.com at all. Requests to {workspace}.api.bytephase.com for a white-label workspace fail with a 412 because the workspace cannot be identified from that host.
Staging is ours, not a sandbox
Section titled “Staging is ours, not a sandbox”The staging environment is BytePhase’s own pre-release environment. It runs code that is about to ship, its data is reset from time to time, and it is not open to customers. It is listed here so that our own team and partners building with us can target it — not as a place to get test credentials. Please do not ask support for staging access.
There is no sandbox — use a trial workspace
Section titled “There is no sandbox — use a trial workspace”To test safely, create a trial workspace at bytephase.com. It behaves exactly like production because it is production: same endpoints, same validation, same duplicate rules, same limits. Create a key in it, point your integration at it, submit as much as you like, and switch the base URL and key to your real workspace when you are done.
What the trial workspace gives you that a sandbox would:
| Need | How |
|---|---|
| Try requests without touching real data | Trial workspace + API reference “Try it” |
| Test a form integration end to end | The Send test button on the integration in BytePhase, then check the submission log |
| Recover from a failed submission | Retry it from the submission log |
| Destructive testing | Not supported; nothing on this API deletes data |
Records created in a workspace through the API are real records in that workspace. Clean them up in the app if you test against a live one.
Which environment am I on?
Section titled “Which environment am I on?”GET /api/integrations/ping answers in one request: a 200 with "status": "connected" means the key, the host and the workspace all line up. See Quick Start.