JSON API

This page starts with setup prerequisites and then provides an overview of available JSON API examples.

Before You Start

These examples use direct HTTP requests and do not use an SDK.

• Use a Dataset ID, Server URL, and an API Credential from My Relewise.
• Start from the API Reference for request models, endpoints, and schemas.
• Follow Getting Started and Implementation Steps for setup and authentication.

Authentication

Create an API Credential in My Relewise with only the permissions your integration requires. API Key and OAuth 2.0 (Client Credentials) are both options for backend integrations. Browser applications use API Keys. Store backend API Keys and OAuth Client Secrets in secure server-side configuration, never in source code.

Select your credential's method below. Both methods use the same API endpoints and JSON request bodies.

Send the API Key in the Authorization header of each request to the Dataset's Server URL:

Authorization: APIKey <api-key>

API Keys can be used from browsers or backends. Configure allowed origins for browser keys. See Network Restrictions.

Examples

• Integrations

  • Making Product Updates using RAW JSON