Skip to content

Add documentation: Clarify Authentication Methods and API Key Availability #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

quantstruct-dev-sarthak[bot]
Copy link

Authentication

This document explains how to authenticate with the API. Proper authentication is required to access any of the API endpoints.

Introduction

Currently, the API uses a combination of X-API-Key and X-API-Secret for authentication. These headers must be included in every request you make to the API.

Important: API keys are currently not self-service. Please contact the founders to request your API key and secret. We are working towards providing a self-service option in the future. Check back here for updates.

Quickstart

To make a successful API call, you'll need to include the X-API-Key and X-API-Secret headers in your request. Here's an example using curl:

curl -X POST \
  'https://your-api-endpoint/v1/messages/individual/{accountId}/send' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'X-API-Secret: YOUR_API_SECRET' \
  -d '{
    "content": "Hello, world!",
    "attachment_uri": null,
    "from": "

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants