<!-- Canonical: https://support.mydiagnostics.app/en/api/; language: en -->

SUPPORT CENTRE

# API and integrations

Connect diagnostics to your processes.

2 min read

[Sign in](https://auth.mydiagnostics.app/login/?lang=en) · [Start for free](https://auth.mydiagnostics.app/register/?lang=en)

## Quick start

1. **Open API in Workspace and choose Generate key.** Keys are managed by the company owner.
2. **Choose permissions and expiration, then store the key securely.** The company owner can reveal it again with Show key. Older keys stored only as a hash cannot be revealed.
3. **Keep the key on your integration server.** Send requests to https://[workspace.mydiagnostics.app/api/](https://workspace.mydiagnostics.app/api/) v1 with Authorization: Bearer YOUR_API_KEY.
4. **Use [workspace.mydiagnostics.app/api/docs/](https://workspace.mydiagnostics.app/api/docs/) to verify filters and pagination.** [OpenAPI](https://workspace.mydiagnostics.app/api/v1/openapi.json) describes exact endpoints and response formats.

## Step-by-step screenshots

Actual screenshots of the English interface with demo data. Appearance may vary slightly with the app version.

1. In API, name your integration and choose the key permissions and expiration.

![In API, name your integration and choose the key permissions and expiration.](https://support.mydiagnostics.app/assets/guide-screenshots/en-api-keys.jpg?v=279dc9d72f)

2. Documentation provides the API base URL, authentication and request examples.

![Documentation provides the API base URL, authentication and request examples.](https://support.mydiagnostics.app/assets/guide-screenshots/en-api-docs.jpg?v=512a18b400)

## Define the integration goal first

**API v1 is included in every MyDiagnostics plan.** The company owner creates keys at [workspace.mydiagnostics.app/api/](https://workspace.mydiagnostics.app/api/) . The API reads diagnostic history and details, individual test results, stations and plan usage. Authentication, filters, pagination and examples are documented at [workspace.mydiagnostics.app/api/docs/](https://workspace.mydiagnostics.app/api/docs/) . Import the [OpenAPI](https://workspace.mydiagnostics.app/api/v1/openapi.json) specification into Postman or Swagger.

## Map data and device identities

**Define an unambiguous way to assign results.** Decide how your system handles serial numbers, IMEI, internal jobs and test times. Some device data may be unavailable. Distinguish missing values, incomplete tests and valid results. Handle repeat diagnostics so new results do not silently overwrite an earlier service state.

## Credentials and company separation

**Keep integration credentials on your server.** Never put them in public JavaScript, screenshots or ordinary email attachments. Use only permissions authorised for your own account, never another company’s access. A station pairing code is not automatically an API key. Implement authentication and access renewal from current documentation. If a credential is exposed, arrange revocation and replacement with your administrator or support.

## Test before production deployment

**Verify the integration with a small controlled sample.** Check device identity, times, units and error or outage handling. Make repeated processing safe to prevent duplicates or unintended extra operations. Log only necessary technical information, without passwords or tokens. For help, email the goal, documentation version, error time and an anonymised example to [support@myrepair.app](mailto:support@myrepair.app) .

Steps may vary slightly by app and operating system version.

[All guides](https://support.mydiagnostics.app/en/)

## Continue with another guide

[Install the agent on Mac and Windows](https://support.mydiagnostics.app/en/installation/) [Pair your station](https://support.mydiagnostics.app/en/pairing/) [Your first diagnostics](https://support.mydiagnostics.app/en/first-test/) [Battery and parts authenticity](https://support.mydiagnostics.app/en/battery-parts/) [Reports, labels and exports](https://support.mydiagnostics.app/en/reports/) [Bulk actions and templates](https://support.mydiagnostics.app/en/bulk-templates/) [Device or station not visible](https://support.mydiagnostics.app/en/troubleshooting/)

## Need help?

Free includes public guides; personal technical support is included in paid plans. Email support@myrepair.app with your company name, device model, system version and the step where you stopped. Do not send passwords, access tokens or pairing codes.

[Email support](mailto:support@myrepair.app)

---

[MyDiagnostics](https://mydiagnostics.app/en/) · [Support](https://support.mydiagnostics.app/en/) · [support@myrepair.app](mailto:support@myrepair.app)
