New Admins: Register for our new Pure Lecture Series!
Pure's logos
Pure Help Center for Pure Administrators

If you are a researcher, or other non-admin at your institution, click here.

  • Home
  • Announcements
  • Release Notes
  • Technical user guides
  • Training
  • Events
  • Support
  • Contact Us
  • Home
  • Training
  • Technical user guides
  • Pure API

How Can We Help?

Search Results

Filter By Category

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Contact us

Testing the Pure API Using RapiDocTesting the Pure API Using RapiDoc

Introduction

RapiDoc is a powerful tool that simplifies the process of testing APIs by providing a user-friendly interface to interact with API endpoints. In this article, you will learn how to use the RapiDoc page to test the Pure API.

Throughout this guide, we will walk you through hands-on exercises that demonstrate how to interact with the Pure API using RapiDoc. By the end of this article, you will have a solid understanding of how to test and validate API endpoints using RapiDoc's interface. Let's dive in and explore the world of API testing with RapiDoc.

 

Requirements

  • Pure Admin Account
  • Valid API Key
  • API Documentation

 

Expertise Level

Beginner Friendly - No prior technical knowledge needed. 

 

Getting Started with RapiDoc

To begin testing the Pure API using RapiDoc, follow these next steps:

  1. Access the RapiDoc Page: Start by navigating to the RapiDoc page. Replace the default domain with your API's domain to test your own API endpoints:

    https://Your_URL/ws/api/rapidoc.html


     
  2. Authentication: In the "Authentication" section of the documentation, you will find details on the required API key for accessing and interacting with the endpoints securely. Ensure you provide a valid API key as specified in the documentation before testing the endpoints to ensure secure access and functionality. 


     
  3. Explore API Endpoints: Once you have updated the domain and entered the correct token for the authentication, you will see a list of available API endpoints with descriptions and parameters. Click on an endpoint to view details such as request methods, parameters, and response codes.


     
  4. Testing API Endpoints: Select the desired Endpoint and provide any required parameters. Use the interactive input fields to send requests to your API and analyze the response. 

    After providing the necessary parameters, click the "TRY" button to send the request and view the JSON response.


     
  5. Review and Validate Responses: After making a request and receiving the JSON response, carefully review and validate the data returned. Ensure that the response aligns with the expected outcome based on the request parameters and API documentation.
     

Given that testing directly affects your Pure data, it is vital to approach the process with caution and responsibility. Any modifications or deletions made during testing can have a significant impact on data integrity. 

 

 

 

Published at November 21, 2024

Download
Table of Contents
  1. Introduction
  2. Requirements
  3. Expertise Level
  4. Getting Started with RapiDoc
Related Articles
  • Getting started: Pure API user guide
  • Pure API: Access definitions for content and field filtering
  • Testing the Pure API: A Beginner's Guide
  • Python API Requests: Fundamental Coding Examples
  • Pure API: Inspiration

Was this article helpful?

Yes
No
Give feedback about this article

    About Pure

  • Announcements

    Additional Support

  • Events
  • Client Community
  • Training

    Need Help?

  • Contact Us
  • Submit a Support Case
  • My Cases
  • Linkedin
  • Twitter
  • Facebook
  • Youtube
Elsevier logo Relx logo

Copyright © 2025 Elsevier, except certain content provided by third parties.

  • Terms & Conditions Terms & Conditions
  • Privacy policyPrivacy policy
  • AccesibilityAccesibility
  • Cookie SettingsCookie Settings
  • Log in to Pure Help CenterLog in to Helpjuice Center

Knowledge Base Software powered by Helpjuice

Expand