Skip to content

Renesas Web Data API (1.0.0)

The Renesas Web Data API enables external systems to retrieve product metadata in real time, without relying on manual CSV downloads or periodic feed refreshes. This shift improves data consistency, streamlines integrations, and aligns with modern API-first architectures.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data
Production Server
https://api.renesas.com/web-data/v1
Staging Server
https://api.renesas-dev.com/web-data/v1

Product Part

Endpoints for retrieving product parts.

Operations

Document

Endpoint for retrieving documents.

Operations

Get All Documents

Request

Security
ApiKeyAuth
Query
limitinteger[ 1 .. 100 ]

The number of results to return (default 10).

offsetinteger>= 0

The offset for pagination.

languagestring

Filter by document language (en, ja, zh-hans).

Enum"en""ja""zh-hans"
dcpDocumentIdStartsWithstring

Filter by DCP Document ID prefix.

productIdstring

Filter by associated product ID.

categorystring

Filter by document category.

documentRevisionDateStartstring(date)

Filter by documents revised on or after this date (YYYY-MM-DD).

documentRevisionDateEndstring(date)

Filter by documents revised on or before this date (YYYY-MM-DD).

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/documents?limit=1&offset=0&language=en&dcpDocumentIdStartsWith=string&productId=string&category=string&documentRevisionDateStart=2019-08-24&documentRevisionDateEnd=2019-08-24' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/jsonArray [
agileIdstring

Primary Agile ID of the document.

dcpDocumentIdstring

DCP Document ID, if applicable.

categoryArray of objects

Category.

Example: [[{"level":1,"title":"Category Level 1"},{"level":2,"title":"Category Level 2"}]]
productArray of objects

List of associated products.

Example: [{"productId":"RL78/G13","title":"Sample Product Title","nid":12345,"uuid":"550e8400-e29b-41d4-a716-446655440000","language":"en"}]
titlestring

Title of the document.

typestring

Type of the document (e.g., Flyer, App Note).

fileTypestring

File format (e.g., PDF, DOCX).

secureDocumentboolean

Indicates if the document is secure or restricted.

hrefstring(uri)

Public URL of the document file.

revisionDatestring

Original revision date of the document.

wwwUpdateDatestring

Date the document was last updated on the website.

languagestring

Language of the document (e.g., en, ja, zh-hans).

nidstring

Drupal node ID of the document.

uuidstring

UUID of the document node.

translationArray of objects

List of translations for the document.

Example: [[{"language":"ja","dcpDocumentId":"DOC123456-JA","agileId":"X1234567","href":"/documents/DOC123456-JA"},{"language":"zh-hans","dcpDocumentId":"DOC123456-ZH","agileId":"X1234567","title":"Document Title in Chinese","href":"/documents/DOC123456-ZH"}]]
publishedboolean

Publication status of the document.

featuredboolean

Whether the document is featured or highlighted.

relationshipstring

Relationship or association type, if any.

filenamestring

Original filename of the document.

disclaimerArray of objects

List of associated disclaimer documents.

Example: [{"dcpDocumentId":"DISC789012","language":"en","agileId":"X1234567","title":"Standard Product Disclaimer","href":"/documents/DISC789012"},{"dcpDocumentId":"DISC789013","language":"en","agileId":"X1234567","title":"Export Control Disclaimer","href":"/documents/DISC789013"}]
myrenesasDocumentboolean

Is a MyRenesas document.

]
Response
application/json
[
  {
    "agileId": "string",
    "dcpDocumentId": "string",
    "category": [ … ],
    "product": [ … ],
    "title": "string",
    "type": "string",
    "fileType": "string",
    "secureDocument": true,
    "href": "http://example.com",
    "revisionDate": "string",
    "wwwUpdateDate": "string",
    "language": "string",
    "nid": "string",
    "uuid": "string",
    "translation": [ … ],
    "published": true,
    "featured": true,
    "relationship": "string",
    "filename": "string",
    "disclaimer": [ … ],
    "myrenesasDocument": true
  }
]

Get Document by DCP Document ID

Request

Security
ApiKeyAuth
Path
dcp_idstringrequired

The DCP document identifier.

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/documents/{dcp_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
agileIdstring

Primary Agile ID of the document.

dcpDocumentIdstring

DCP Document ID, if applicable.

categoryArray of objects

Category.

Example: [[{"level":1,"title":"Category Level 1"},{"level":2,"title":"Category Level 2"}]]
productArray of objects

List of associated products.

Example: [{"productId":"RL78/G13","title":"Sample Product Title","nid":12345,"uuid":"550e8400-e29b-41d4-a716-446655440000","language":"en"}]
titlestring

Title of the document.

typestring

Type of the document (e.g., Flyer, App Note).

fileTypestring

File format (e.g., PDF, DOCX).

secureDocumentboolean

Indicates if the document is secure or restricted.

hrefstring(uri)

Public URL of the document file.

revisionDatestring

Original revision date of the document.

wwwUpdateDatestring

Date the document was last updated on the website.

languagestring

Language of the document (e.g., en, ja, zh-hans).

nidstring

Drupal node ID of the document.

uuidstring

UUID of the document node.

translationArray of objects

List of translations for the document.

Example: [[{"language":"ja","dcpDocumentId":"DOC123456-JA","agileId":"X1234567","href":"/documents/DOC123456-JA"},{"language":"zh-hans","dcpDocumentId":"DOC123456-ZH","agileId":"X1234567","title":"Document Title in Chinese","href":"/documents/DOC123456-ZH"}]]
publishedboolean

Publication status of the document.

featuredboolean

Whether the document is featured or highlighted.

relationshipstring

Relationship or association type, if any.

filenamestring

Original filename of the document.

disclaimerArray of objects

List of associated disclaimer documents.

Example: [{"dcpDocumentId":"DISC789012","language":"en","agileId":"X1234567","title":"Standard Product Disclaimer","href":"/documents/DISC789012"},{"dcpDocumentId":"DISC789013","language":"en","agileId":"X1234567","title":"Export Control Disclaimer","href":"/documents/DISC789013"}]
myrenesasDocumentboolean

Is a MyRenesas document.

Response
application/json
{
  "agileId": "string",
  "dcpDocumentId": "string",
  "category": [
    [ … ]
  ],
  "product": [
    { … }
  ],
  "title": "string",
  "type": "string",
  "fileType": "string",
  "secureDocument": true,
  "href": "http://example.com",
  "revisionDate": "string",
  "wwwUpdateDate": "string",
  "language": "string",
  "nid": "string",
  "uuid": "string",
  "translation": [
    [ … ]
  ],
  "published": true,
  "featured": true,
  "relationship": "string",
  "filename": "string",
  "disclaimer": [
    { … },
    { … }
  ],
  "myrenesasDocument": true
}

Get Document by Agile ID

Request

Security
ApiKeyAuth
Path
agile_idstringrequired

The Agile ID of the document.

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/documents/agile-id/{agile_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
agileIdstring

Primary Agile ID of the document.

dcpDocumentIdstring

DCP Document ID, if applicable.

categoryArray of objects

Category.

Example: [[{"level":1,"title":"Category Level 1"},{"level":2,"title":"Category Level 2"}]]
productArray of objects

List of associated products.

Example: [{"productId":"RL78/G13","title":"Sample Product Title","nid":12345,"uuid":"550e8400-e29b-41d4-a716-446655440000","language":"en"}]
titlestring

Title of the document.

typestring

Type of the document (e.g., Flyer, App Note).

fileTypestring

File format (e.g., PDF, DOCX).

secureDocumentboolean

Indicates if the document is secure or restricted.

hrefstring(uri)

Public URL of the document file.

revisionDatestring

Original revision date of the document.

wwwUpdateDatestring

Date the document was last updated on the website.

languagestring

Language of the document (e.g., en, ja, zh-hans).

nidstring

Drupal node ID of the document.

uuidstring

UUID of the document node.

translationArray of objects

List of translations for the document.

Example: [[{"language":"ja","dcpDocumentId":"DOC123456-JA","agileId":"X1234567","href":"/documents/DOC123456-JA"},{"language":"zh-hans","dcpDocumentId":"DOC123456-ZH","agileId":"X1234567","title":"Document Title in Chinese","href":"/documents/DOC123456-ZH"}]]
publishedboolean

Publication status of the document.

featuredboolean

Whether the document is featured or highlighted.

relationshipstring

Relationship or association type, if any.

filenamestring

Original filename of the document.

disclaimerArray of objects

List of associated disclaimer documents.

Example: [{"dcpDocumentId":"DISC789012","language":"en","agileId":"X1234567","title":"Standard Product Disclaimer","href":"/documents/DISC789012"},{"dcpDocumentId":"DISC789013","language":"en","agileId":"X1234567","title":"Export Control Disclaimer","href":"/documents/DISC789013"}]
myrenesasDocumentboolean

Is a MyRenesas document.

Response
application/json
{
  "agileId": "string",
  "dcpDocumentId": "string",
  "category": [
    [ … ]
  ],
  "product": [
    { … }
  ],
  "title": "string",
  "type": "string",
  "fileType": "string",
  "secureDocument": true,
  "href": "http://example.com",
  "revisionDate": "string",
  "wwwUpdateDate": "string",
  "language": "string",
  "nid": "string",
  "uuid": "string",
  "translation": [
    [ … ]
  ],
  "published": true,
  "featured": true,
  "relationship": "string",
  "filename": "string",
  "disclaimer": [
    { … },
    { … }
  ],
  "myrenesasDocument": true
}

Board & Kit

Endpoints for retrieving boards and kits.

Operations