Skip to content

Commit 1518f08

Browse files
add summary page
1 parent 105adfb commit 1518f08

File tree

4 files changed

+20
-2
lines changed

4 files changed

+20
-2
lines changed

fern/docs/pages/api-summary.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
The DevRev API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
2+
3+
You can use the DevRev API in test a demo organization which doesn’t affect your live data or interact with your real customers.
4+
5+
To create a new organization in DevRev:
6+
7+
1. Click on your profile picture on the top left corner.
8+
2. Go to the **Orgs** section and click on **+**.
9+
3. Fill in the details and click **Create**.
10+
11+
Now you can find your newly created org in **Orgs**.
12+
13+
Login into your demo org and [obtain the PAT token](/about/authentication#generate-a-personal-access-token-pat).
14+
Now you can use this PAT token to make test API calls and try building something new.
15+
16+
## Just getting started?
17+
18+
Check out our [getting started](/api-reference/getting-started) guide.

fern/docs/pages/welcome.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
The DevRev API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.
21
If you're new to DevRev APIs, you've come to the right place. Our APIs serve as the foundation for integrating your apps, building automations, and creating custom snap-ins.
32
You can also refer to our [Postman collection](https://postman.devrev.ai/).
43

fern/fern.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"organization": "devrev",
3-
"version": "0.23.6"
3+
"version": "0.23.7"
44
}

fern/versions/public.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ navigation:
1515
path: ../docs/pages/responses.mdx
1616
- api: API Reference
1717
api-name: public
18+
summary: ../docs/pages/api-summary.mdx
1819
layout:
1920
- page: Getting started
2021
path: ../docs/pages/welcome.mdx

0 commit comments

Comments
 (0)