Perculus API Documentation
English V2
TurkishEnglishEnglish V2Turkish V2
English V2
TurkishEnglishEnglish V2Turkish V2
  • 🚀Quick Start
    • 🔑Creating API Keys
    • 🔓Authorization
      • Authorization with NodeJS
  • ⚙️Services
    • 👩‍🏫User Management
      • 👶Creating a User
      • 👩Updating a User
      • 👩‍🦳Deleting a User
      • Selecting a User
      • 🕵️‍♀️Searching Users
    • 📙Session Management
      • ⛳Creating and Updating Sessions
        • Create Session Object
        • Update Session Object
        • Session Options Object
      • ❌Deleting a Session
      • Selecting a Session
      • 📚Searching Sessions
    • 👩‍🎓Attendee Management
      • ✍️Creating and Updating Attendees
        • 🔗Attendance Link
        • Upsert by User
        • Upsert by Email (Guests)
        • Update By Attendance Code
      • Deleting an Attendee
      • Selecting an Attendee
      • Searching Attendees
    • 📄Reports
      • Participant Stats
        • ParticipantStat
      • Session Stats
  • 🔨Misc
    • Error Codes
    • 🪝Webhooks
  • accepted formats
    • 📅Dates
    • 🇺🇳Languages
    • 🙋‍♀️Roles
    • 🕙Timezones
Powered by GitBook
On this page
  • Introduction to Perculus API
  • API Keys

Was this helpful?

  1. Quick Start

Creating API Keys

NextAuthorization

Last updated 29 days ago

Was this helpful?

Introduction to Perculus API

You can integrate Perculus into your platform or application with the help of our REST API. It allows you to carry out most of the functions that can be performed on Perculus, such as managing sessions and users and creating reports.The API can be utilized in two ways:

  • Direct access: You can directly call the API endpoints. We provide sample cURL commands throughout the documentation.

  • Software development kits (SDKs): We currently have an SDK for NodeJS and Pyhton SDK is on its way.

API Keys

In order to create an API Key, first go to the Development section under Settings, and click the Create new API Key button.

After naming your API Key and press Create, you will see a window with your Access Key and Secret Key. Make sure to copy your Secret Key to a safe location, since you will not be seeing it again.

Compromise of your secret key may result in unauthorized access to your data. Make sure to store it in a safe location and never share it.

You can authorize your requests using these credentials, please page in order to figure out how.

🚀
🔑
see this