Introduction
This article provides a clear overview of the base URLs for the sandbox (test) and production environments of the Symmetry Tax Engine API, as well as the required request headers to authenticate and format your requests properly. Understanding these fundamentals is essential for successful integration with the Symmetry payroll tax compliance platform.
Base URLs for API Environments
Symmetry provides distinct base URLs depending on whether you are interacting with the sandbox or the production environment. Using the correct base URL is crucial to ensure your API calls are routed appropriately.
| Environment | Base URL |
|---|---|
| Sandbox (Test) Environment | https://api.sandbox.symmetrytax.com |
| Production Environment | https://api.symmetrytax.com |
Required Request Headers
All API requests to the Symmetry Tax Engine must include specific HTTP headers to ensure proper authentication and data formatting. The following headers are required for every request:
- Authorization: A bearer token that authenticates your request. You will receive API keys or tokens after account setup.
- Content-Type: Specifies the format of the request body. Typically, this is set to application/json.
- Accept: Indicates the expected format of the response, usually application/json.
Example of headers in a request:
| Header | Value |
|---|---|
| Authorization | Bearer [your_api_token_here] |
| Content-Type | application/json |
| Accept | application/json |
Getting Your API Token
To obtain your API token, you must first create and verify your Symmetry account. After logging in to your account dashboard, navigate to the API section where you can generate or view your authentication keys for both sandbox and production environments.
Tips for API Request Success
- Always use the correct base URL corresponding to your environment (sandbox or production).
- Include all required headers exactly as specified to avoid authentication or content-type errors.
- Keep your API token secure and do not share it publicly.
- Test your API calls in the sandbox environment before moving to production to ensure smooth integration.
Additional Resources
For more detailed information on API integration, error handling, and advanced configuration, please visit the Symmetry developer documentation or contact Symmetry support at [support email/contact link].
Comments
0 comments
Please sign in to leave a comment.