Skip to content
Last updated

Quickstart Guide

Get started with the Renesas Web Data API in just a few minutes. This guide will walk you through making your first API call to retrieve product part information.

Prerequisites

Before you begin, you'll need:

  • An API key for authentication
  • A tool to make HTTP requests (curl, Postman, or your preferred programming language)

Making Your First Request

1. Set Up Authentication

All API requests require an API key in the x-api-key header. Here's how to authenticate:

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.renesas.com/web-data/v1/product-parts?limit=5

2. Retrieve Product Parts

The simplest way to start is by fetching a few product parts:

curl -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" \
  "https://api.renesas.com/web-data/v1/product-parts?limit=5"

This will return the first 5 product parts in the system.

3. Filter by Part Number

You can filter results by part number prefix:

curl -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" \
  "https://api.renesas.com/web-data/v1/product-parts?part_number_prefix=R5F&limit=10"

4. Get Documents

Retrieve documents associated with products:

curl -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" \
  "https://api.renesas.com/web-data/v1/documents?limit=5"

Understanding the Response

Product Parts Response

A typical product parts response looks like this:

{
  "data": [
    {
      "orderableId": "R5F52318ADFM#30",
      "productCategory": "Microcontrollers",
      "firstProductSubcategory": "32-bit MCUs",
      "genericId": "R5F52318",
      "genericTitle": "RX23T 32-bit Microcontroller",
      "productFamily": "RX",
      "1kuPrice": 2.85,
      "status": "Active",
      "type": "IC",
      "description": "32-bit MCU with enhanced PWM functions"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 1500
  }
}

Key Fields

  • orderableId: Unique identifier for ordering the specific part
  • genericId: Generic product identifier (family identifier)
  • productFamily: Product family name (e.g., RX, RA, RZ)
  • status: Current lifecycle status (Active, NRND, Obsolete)
  • 1kuPrice: Price per 1000 units

Next Steps

Now that you've made your first API calls, explore more advanced features:

Common Use Cases

Integration Examples

Finding parts by status:

curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.renesas.com/web-data/v1/product-parts?part_status=Active&limit=20"

Getting parts by product family:

curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.renesas.com/web-data/v1/product-parts?product_family=RA&limit=20"

Retrieving specific product documentation:

curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.renesas.com/web-data/v1/documents?productId=R5F52318"

Error Handling

The API uses standard HTTP status codes:

  • 200: Success
  • 400: Bad Request (invalid parameters)
  • 401: Unauthorized (invalid or missing API key)
  • 404: Not Found
  • 500: Internal Server Error

Always check the response status code and handle errors appropriately in your applications.

Rate Limiting

Be mindful of rate limits when integrating the API. Implement appropriate retry logic and respect any rate limiting headers in the responses.

Previous page
Next page