1️⃣ Generate an API Key

Before making API requests, you must create an API Key in Docusnap365.

Steps to create an API Key:

1. In Docusnap365, click the gear icon (top right) and select API Keys.
2. Click New.
3. Enter a name for your API key (e.g., README-Api-Key).
4. Set an expiration date (e.g., 28.02.20XX).
5. Assign the necessary permissions:
   • Read → Required for GET requests.
   • Write → Required for POST, PUT, and DELETE requests.

⚠

If you don’t enable the Write permission, POST, PUT, and DELETE requests will result in a 403 Forbidden error.

2️⃣ Authenticate API Requests

Once you have an API Key, include it in every request using the x-api-key header.

Example Request

GET /api/v2/segment/iphosts HTTP/1.1
Host: api.docusnap365.com
x-api-key: YOUR_API_KEY_HERE

3️⃣ Using ReadMe.io to Test API Requests

Docusnap365 API is fully integrated with ReadMe.io, allowing you to test API requests directly in your browser.

Features

• Test API Calls Instantly: Run requests without additional tools.
• Auto-Generate Code: Get ready-to-use snippets for Python, Node.js, C#, etc.
• Find & Explore Endpoints: Quickly browse API methods and required parameters.

How to use the ReadMe API Explorer

1. Navigate to any API endpoint in the documentation.
2. Enter your API Key under "Credentials".
3. Click Try It to execute the request.
4. Copy the generated code snippet for your preferred language.

📘

The ReadMe API Explorer allows you to test API calls without additional tools and instantly generate code snippets.