Start here
Templates
Ready-made collections of requests with their checks — REST basics, signing in, Salesforce, NetSuite and OData — that run straight away against the practice systems built into the app.
A template is a ready-made collection: requests, their checks, and an environment with the values they use. Each one runs straight away against the practice systems built into the app, so you need no account and no one's data. When you're ready, point it at your own system by changing the environment's values.
Start from one
- In the app: on the Home page, choose Start from a template. You can also press Ctrl+K and type template. Pick one and the Import window shows exactly what it adds, before anything is saved. Press Import.
- From this page: Open in APITestCenter opens the installed app on that template. Download gives you the file: open it with the app, or import it with Import.
- From a terminal: run
atc import template:<name>, thenatc suite "<collection>" --env "<collection>".atc templateslists them all. See CLI and CI.
Then open Run collection and press Run. Every request should pass.
The templates
| Template | What it shows | |
|---|---|---|
| REST basics: read a list, read one item and check a missing one | GET requests, checks on status, body and speed, a collection run | Open in APITestCenter · Download · atc import template:rest-basics |
| Sign in, create, read back: sign in once, use the token, pass a new order's id along | Bearer token, Run first and Save values | Open in APITestCenter · Download · atc import template:sign-in-and-chain |
| SuccessFactors to NetSuite: did the employee arrive?: read an employee in SuccessFactors, find the copy in NetSuite, check every field | Two systems in one collection run, a saved record, a field mapping check | Open in APITestCenter · Download · atc import template:successfactors-to-netsuite |
| Salesforce: objects and SOQL: list objects, describe one, run SOQL queries | OAuth 2.0 client credentials, SOQL, describe | Open in APITestCenter · Download · atc import template:salesforce-soql |
| NetSuite: SuiteQL and records: read the record catalog and run SuiteQL | OAuth 2.0, SuiteQL, metadata | Open in APITestCenter · Download · atc import template:netsuite-suiteql |
OData (SAP SuccessFactors style): $metadata, then $filter, $select, $top and $expand | Basic sign-in, OData v2 and v4 | Open in APITestCenter · Download · atc import template:odata-sap |
| Speed and reliability checks: a slow request, one that sometimes fails, a form upload | Time limits, a start for performance tests, multipart forms | Open in APITestCenter · Download · atc import template:reliability-checks |
Open in APITestCenter needs the desktop app, version 0.19 or later. If nothing happens, use Download instead. SuccessFactors to NetSuite needs version 0.20 or later.
Use one on your own system
Each template keeps its addresses and sign-in details in its environment. Your requests stay the same; only the values change:
- Pick the template's environment next to the URL bar, then open it to edit the values.
- Replace the practice address (
{{practiceApi}}/…) with your system's, and the practice sign-in (practice/demo) with your own. - Tick secret for passwords and client secrets. They're then encrypted on your computer and left out of every export.
Try a sandbox or test system first, never production. The Import window also tells you what each template needs:
- Salesforce: your org's My Domain address (
https://your-company.my.salesforce.com), plus a connected app's consumer key and secret. - NetSuite:
https://<account-id>.suitetalk.api.netsuite.com. A real account usually signs in with OAuth 2.0 using a certificate or a browser sign-in, as its integration record allows. Choose it on the Auth tab, or let Connections set it up. - OData / SuccessFactors: your service's address (for SuccessFactors,
https://<api-server>/odata/v2), and an API user's name (username@companyId) and password. Then change the entity names to your service's.
To learn how each system's API works and what to test on it, read the lessons on Salesforce, NetSuite and SAP SuccessFactors.
APITestCenter works with these systems through their public APIs. It isn't made or endorsed by Salesforce, Oracle NetSuite or SAP.
Share your own
Any collection can become a template for your team. Choose Export requests (Ctrl+K), then APITestCenter. The file opens in the app with a double-click and imports with atc import. See Exports.