mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 08:13:56 +10:00
chore: started api documentation
This commit is contained in:
@ -20,9 +20,10 @@
|
||||
"title": "Local Development",
|
||||
"type": "page"
|
||||
},
|
||||
"api": {
|
||||
"title": "API",
|
||||
"type": "page"
|
||||
"public-api": {
|
||||
"title": "Public API",
|
||||
"type": "page",
|
||||
"href": "/fcc/"
|
||||
},
|
||||
"webhooks": {
|
||||
"title": "Webhooks",
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
# Hello world
|
||||
|
||||
Hey there!
|
||||
6
apps/documentation/pages/public-api/_meta.json
Normal file
6
apps/documentation/pages/public-api/_meta.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"intro": "Intro",
|
||||
"authentication": "Authentication",
|
||||
"versioning": "Versioning",
|
||||
"api-reference": "API Reference"
|
||||
}
|
||||
33
apps/documentation/pages/public-api/authentication.mdx
Normal file
33
apps/documentation/pages/public-api/authentication.mdx
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
title: 'API Authentication'
|
||||
description: 'Learn how to create a Documenso API key and authenticate your API requests.'
|
||||
---
|
||||
|
||||
# API Authentication
|
||||
|
||||
Documenso uses API keys for authentication. An API key is a unique token that is generated for each client. The client must provide the key whenever it makes an API call. This way, Documenso can identify the clients making the requests and authorize their access to the API.
|
||||
|
||||
## Creating an API Key
|
||||
|
||||
To create an API key, you need to navigate to the user settings page. Click on your avatar in the top right corner of the dashboard and select "**[User settings](https://app.documenso.com/settings)**" from the dropdown menu.
|
||||
|
||||

|
||||
|
||||
Once you're on the user settings page, navigate to the "**[API Tokens](https://app.documenso.com/settings/tokens)**" tab. The "API Token" page lists your existing keys and enables you to create new ones.
|
||||
|
||||

|
||||
|
||||
To create a new API key, you must:
|
||||
|
||||
- Choose a name (e.g. "zapier-key")
|
||||
- we recommend using a descriptive name that helps you easily identify the key and its purpose
|
||||
- Choose an expiration date
|
||||
- you can set the key to never expire or choose when to become invalid: 7 days, 1 month, 3 months, 6 months, or 1 year
|
||||
|
||||
After providing the required information, click the "Create token" button to generate the API key.
|
||||
|
||||

|
||||
|
||||
Once you've created the token, Documenso will display the key on the screen. Make sure to copy the key and store it securely. You won't be able to see the key again once you refresh/leave the page.
|
||||
|
||||
## Using the API Key
|
||||
9
apps/documentation/pages/public-api/intro.mdx
Normal file
9
apps/documentation/pages/public-api/intro.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
# Public API
|
||||
|
||||
## Swagger Documentation
|
||||
|
||||
Documenso also provides [Swagger documentation](https://app.documenso.com/api/v1/openapi). This documentation provides information about the API endpoints, request parameters, response formats, and authentication methods.
|
||||
|
||||
## Availability
|
||||
|
||||
The API is available to individual users and teams.
|
||||
@ -18,11 +18,11 @@ Documenso supports Webhooks and allows you to subscribe to the following events:
|
||||
|
||||
## Create a webhook subscription
|
||||
|
||||
You can create a webhook subscription from the user settings page. Click on your avatar in the top right corner of the dashboard and select "**User settings**" from the dropdown menu.
|
||||
You can create a webhook subscription from the user settings page. Click on your avatar in the top right corner of the dashboard and select "**[User settings](https://app.documenso.com/settings)**" from the dropdown menu.
|
||||
|
||||

|
||||
|
||||
Then, navigate to the "**Webhooks**" tab, where you can see a list of your existing webhooks and create new ones.
|
||||
Then, navigate to the "**[Webhooks](https://app.documenso.com/settings/webhooks)**" tab, where you can see a list of your existing webhooks and create new ones.
|
||||
|
||||

|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
Reference in New Issue
Block a user