Getting Started

Everything you need to start using the McLaren API Portal

1

Portal Overview

The McLaren API Portal is your centralised gateway to all enterprise integration APIs across McLaren Automotive. It provides a unified interface to discover, explore, and test APIs from systems including 3DEXPERIENCE, Dynamics 365, ConfigIT ACE, SAP S/4HANA, and more.

Each API is organised by system, with full OpenAPI specifications, interactive testing capabilities, and code samples in multiple languages. The portal is managed by the Integration Team and updated automatically as new APIs are published through Azure API Management.

2

Getting Access

The portal uses McLaren's Microsoft Entra ID (Azure AD) for authentication. To access the portal:

Click Sign In at the top right of the portal and authenticate with your McLaren email address.

Your account must have either the User or Admin role assigned in the McLaren API Portal enterprise application.

Once authenticated, you'll see the full API Catalogue with all available systems and APIs.

Need access? Contact the Integration Team to get the appropriate role assigned to your account.

3

Making Your First API Call

The portal provides a built-in "Try It" console that lets you test any API operation directly from your browser without needing to set up external tools.

Step 1: Browse the Catalogue

Navigate to the API Catalogue on the homepage and select a system card (e.g., Dynamics 365).

Step 2: Select an Operation

Use the sidebar to navigate through APIs and their operations. Click on any operation to view its details.

Step 3: Open the Try It Tab

Switch to the "Try It" tab in the operation view. The authentication is handled automatically by the portal — no API key entry required.

Step 4: Configure and Send

Fill in any required parameters, adjust query values as needed, and click Send Request. The response will appear below with status code, headers, and body.

4

Authentication

All APIs are secured through Azure API Management and require authentication. The portal supports two modes:

Portal Try It (Automatic)

When using the built-in Try It console, authentication is handled transparently by the portal. API keys are managed server-side and never exposed to the browser.

Production Integration

For production use, you'll need a dedicated subscription key issued through the Subscription Management process. Include the key in the Ocp-Apim-Subscription-Key header with every request.

5

API Standards & Conventions

Base URLs

All APIs are hosted behind the McLaren API Management gateway. Base URLs follow the pattern:

https://mclapidev.azure-api.net/<api-path>

Response Format

All APIs return JSON responses with Content-Type: application/json. Include Accept: application/json in your request headers.

HTTP Methods

GET — Retrieve dataPOST — Create resourcePATCH — Partial updatePUT — Full replacementDELETE — Remove resource

Error Handling

APIs use standard HTTP status codes. Common responses include 200 (OK), 201 (Created), 400 (Bad Request), 401 (Unauthorised), 403 (Forbidden), 404 (Not Found), and 429 (Rate Limited).

Rate Limits & Quotas

API usage is subject to rate limiting configured at the Azure API Management level. Rate limits vary by subscription tier and API. When limits are exceeded, the API returns a 429 Too Many Requests response with a Retry-After header indicating when you can retry.

6

Code Samples

Each API operation in the portal includes ready-to-use code samples in cURL, PowerShell, and Python. Navigate to any operation and click the "Code Samples" tab to copy and adapt them for your integration.

Example — cURL
curl -X GET "https://mclapidev.azure-api.net/your-api/endpoint" \
  -H "Ocp-Apim-Subscription-Key: YOUR_KEY" \
  -H "Accept: application/json"
7

FAQ & Troubleshooting

I can't sign in to the portal
Ensure you're using your McLaren email address (@mclaren.com). If you can sign in to other Microsoft 365 services but not the portal, you may need the appropriate role assigned. Contact the Integration Team.
I'm getting a 401 Unauthorised error
For the portal's built-in Try It console, authentication is automatic. If you're calling APIs externally, ensure your subscription key is valid and included in the Ocp-Apim-Subscription-Key header.
I can't see any APIs in the catalogue
The API catalogue is only visible to authenticated users. Make sure you're signed in. If you're signed in but still see no APIs, some systems may be temporarily under maintenance or your role may not have catalogue visibility enabled.
How do I get a production subscription key?
Production subscription keys are managed through the Subscription Management process, which is currently under development. In the meantime, contact the Integration Team directly for production API access.