Skip to main content

Authentication

This document outlines the necessary steps to authenticate and access our API.

API Key Authentication​

  • Header: X-Api-Key={key}

How to Obtain an API Key​

  • Contact Support: Reach out to our technical support team to request an API key.
  • Generate Key: Alternatively, you can generate a developer key from the organization settings page at app.vinter.me/organization/settings.

Steps to Generate an API Key​

  1. Access Organization Settings: Navigate to the Development Options tab in the organization settings page.
  2. Create API Key: Click the designated button to generate your API key as per your requirements.

Note:
For integrated systems, a user-specific authentication method using a User Secret Key (X-User-Secret-Key={key}) might also be available. Detailed documentation for this method is provided in a separate document.