chore: Include 'Bearer' in authorization header documentation #247
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment.
There was a problem hiding this comment.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -19,7 +19,7 @@ flowchart TD | |||||
| acct-create[accounts.create] | ||||||
| exist(((Account is existing | ||||||
| 'account ID'))) | ||||||
| list[rev-orgs.list with | ||||||
| 'account' filter] | ||||||
| get[rev-orgs.get with | ||||||
| 'account ID'] | ||||||
|
|
@@ -52,7 +52,7 @@ The payload to make a request is given below: | |||||
| curl --location 'https://api.devrev.ai/accounts.create' \ | ||||||
| --header 'Content-Type: application/json' \ | ||||||
| --header 'Accept: application/json' \ | ||||||
| --header 'Authorization: Bearer <PAT>' \ | ||||||
| --data '{ | ||||||
| "display_name": "John Doe" | ||||||
| }' | ||||||
|
|
@@ -126,9 +126,9 @@ The payload to make a request is given below: | |||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| The response contains `"external_ref": "don:identity:dvrv-us-1:devo/<devo-id>:account/<acc-id>",`. The `external_ref` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `account` ID as `account/<acc-id>`. | ||||||
|
|
||||||
| 1. Check **Customers > Accounts** in the DevRev app to confirm that the account was created. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
|
|
@@ -139,19 +139,19 @@ To create a contact associated with the account you created, follow the steps li | |||||
| Get the default rev org created along with the newly created account using the `rev-orgs.list` API: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 1. Make a GET/POST request to "https://api.devrev.ai/rev-orgs.list" using cURL with the `account` filter. Use the `external_ref` from the previous response as an `account` filter. | ||||||
|
|
||||||
| ```bash | ||||||
| curl -X POST https://api.devrev.ai/rev-orgs.list \ | ||||||
| -H "Authorization: Bearer <apiKey>" \ | ||||||
| -H "Content-Type: application/json" \ | ||||||
| -d '{"account": [ | ||||||
| "<external reference of the account>" | ||||||
| ] | ||||||
| }' | ||||||
| ``` | ||||||
|
|
||||||
| It returns the following response: | ||||||
|
|
||||||
| ```json focus={19} | ||||||
| { | ||||||
| "rev_orgs": [ | ||||||
|
|
@@ -189,26 +189,26 @@ Get the default rev org created along with the newly created account using the ` | |||||
| ] | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| Note the `display_id` (example: `REV-abcd`) of the rev org from the response. | ||||||
|
|
||||||
| - If there is an existing account then you can get the default rev org using the `rev-orgs.get` API: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `account` filter. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ```bash | ||||||
| curl -G https://api.devrev.ai/rev-orgs.get \ | ||||||
| -H "Authorization: Bearer <apiKey>" \ | ||||||
| -d account=ACC-12345 \ | ||||||
| ``` | ||||||
|
|
||||||
| 2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a rev-user. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| In the request, set `rev_org` to the value of the `display_id` from the previous reponse. | ||||||
|
|
||||||
| ```bash | ||||||
| curl -X POST https://api.devrev.ai/rev-users.create \ | ||||||
| -H "Authorization: Bearer <apiKey>" \ | ||||||
| -H "Content-Type: application/json" \ | ||||||
| -d '{ | ||||||
| "rev_org": "<rev org display-id>" | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
fern-api-docs/fern/docs/pages/create-accounts.mdx
Line 1 in 28968b8