{"_id":"583853b22d28532d003772aa","version":{"_id":"56e29a8dd3b68d0e00b48ffd","hasReference":true,"project":"56e29a8dd3b68d0e00b48ffa","__v":15,"hasDoc":true,"createdAt":"2016-03-11T10:14:37.460Z","releaseDate":"2016-03-11T10:14:37.460Z","categories":["56e29a8ed3b68d0e00b48ffe","56eb917a2e58011700afdfcc","56eb92252109011700f3ba5e","5704d4af849f721900f27835","57052a31473f900e004d5d54","5715222811537f19006aab2d","5715b57b810df00e00cc7832","5715baa9810df00e00cc7837","57180ed83a17770e009a7322","571810273a17770e009a7325","579b22d3f4ad7b190094b60e","584538ecba4f1c0f0096925e","586bb88e5602870f00ae7177","5a70407fb0a01400369583c5","5ace359e40606a0003eac1de"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"githubsync":"","parentDoc":null,"project":"56e29a8dd3b68d0e00b48ffa","__v":1,"category":{"_id":"56e29a8ed3b68d0e00b48ffe","pages":["56e29a8fd3b68d0e00b49000","56e635e0cfa58f0e00eafcfe","56e6482dba14ad0e0000f523","56e64c9fcfa58f0e00eafd13","56e64d5aec3f760e00105fcc","56e653bf0121c60e006e5e24","56e8fc98c88bf80e00f8bf2c","56e982bf8617502200f19c11","56e98680f3c3031900041bf6","56e98c69cbeede0e0006e56c","56eb8a7b1633510e00f884fa"],"project":"56e29a8dd3b68d0e00b48ffa","version":"56e29a8dd3b68d0e00b48ffd","__v":11,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-11T10:14:38.490Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"5795d43eb9ee2d0e00df357a","updates":["59a8155a75af05000fbd8847"],"next":{"pages":[],"description":""},"createdAt":"2016-11-25T15:07:30.250Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"The Sandbox environment is a complete environment that allows users to test the Single-Invoice.co methods safely. \n\nTo start testing, simply follow the steps below: \n\n1. Sign up for a Sandbox account in our Developer Portal at https://developer-demo.single-invoice.co .\n2. Once you've verified your email address, you'll need to wait for your account to be approved (this usually happens very quickly during business hours). \n3. When your account is approved, you'll be able to log into the Developer Portal and create a Coverage API Key. \n4. Reference the Sandbox API endpoint - https://api-demo.single-invoice.co/v2 - in your code. \n5. Start searching for companies, requesting quotes, and more!\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Important note regarding Company IDs\",\n  \"body\": \"Single-Invoice.co uses GUIDs (e.g., e11ce689-fed9-f788-4ab9-a6088388afc4) to uniquely identify companies. \\n\\nPlease note that due to the way GUIDs are created, the same company will have a different GUID between our environments. \\n\\nThis means that if you search for a company by an External ID (for example, a SIREN or UK Companies House registration number), the GUID returned in our Sandbox environment will be different to the GUID you get in our production environment.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Simulation Mode\"\n}\n[/block]\nOur Sandbox environment may sometimes be running in \"Simulation mode\". This means that instead of testing against the usual \"live\" testing endpoint we have internally for company information, we're instead using a pre-defined data set that have fixed grades. \n\nThis may occasionally lead to unusual results (for example, companies that are known to be financially very strong may sometimes present as weak or even out of business, and vice versa). \n\nYou can check to see if Simulation mode is enabled by looking at the response headers - when it is on, we send the following header:\n\nX-SimulationMode: on\n\nWhen Simulation Mode is not on in the Sandbox, the results you get will still come from a testing environment but will tend to be more realistic, as they simply come from an older set of company data.","excerpt":"Information on the Sandbox.","slug":"sandbox","type":"basic","title":"Sandbox Environment"}

Sandbox Environment

Information on the Sandbox.

The Sandbox environment is a complete environment that allows users to test the Single-Invoice.co methods safely. To start testing, simply follow the steps below: 1. Sign up for a Sandbox account in our Developer Portal at https://developer-demo.single-invoice.co . 2. Once you've verified your email address, you'll need to wait for your account to be approved (this usually happens very quickly during business hours). 3. When your account is approved, you'll be able to log into the Developer Portal and create a Coverage API Key. 4. Reference the Sandbox API endpoint - https://api-demo.single-invoice.co/v2 - in your code. 5. Start searching for companies, requesting quotes, and more! [block:callout] { "type": "warning", "title": "Important note regarding Company IDs", "body": "Single-Invoice.co uses GUIDs (e.g., e11ce689-fed9-f788-4ab9-a6088388afc4) to uniquely identify companies. \n\nPlease note that due to the way GUIDs are created, the same company will have a different GUID between our environments. \n\nThis means that if you search for a company by an External ID (for example, a SIREN or UK Companies House registration number), the GUID returned in our Sandbox environment will be different to the GUID you get in our production environment." } [/block] [block:api-header] { "title": "Simulation Mode" } [/block] Our Sandbox environment may sometimes be running in "Simulation mode". This means that instead of testing against the usual "live" testing endpoint we have internally for company information, we're instead using a pre-defined data set that have fixed grades. This may occasionally lead to unusual results (for example, companies that are known to be financially very strong may sometimes present as weak or even out of business, and vice versa). You can check to see if Simulation mode is enabled by looking at the response headers - when it is on, we send the following header: X-SimulationMode: on When Simulation Mode is not on in the Sandbox, the results you get will still come from a testing environment but will tend to be more realistic, as they simply come from an older set of company data.