Skip to content

Commit d28ea4a

Browse files
authored
Merge branch 'main' into nihar/companies-rest-api-doc
2 parents f8938e9 + 0f74d86 commit d28ea4a

23 files changed

+3942
-224
lines changed

CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
rest-api.fluentcrm.com

Gemfile.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,4 @@ RUBY VERSION
142142
ruby 2.7.2p137
143143

144144
BUNDLED WITH
145-
2.2.22
145+
2.2.24

source/images/create_manager.png

69.1 KB
Loading
4.73 KB
Loading

source/images/cropped-icon-32x32.png

814 Bytes
Loading

source/images/logo-light.svg

+1
Loading

source/images/logo.svg

+1
Loading

source/images/rest_api_screen.png

56.4 KB
Loading
52.2 KB
Loading

source/includes/_authentication.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
# Authentication
3+
4+
FluentCRM uses WordPress REST API. So you can use any authorization method that supports WordPress.
5+
6+
Once you create your Application Password in WordPress, Add Authorization Header to every request.
7+
8+
> Example API Call for contacts
9+
10+
```shell
11+
# With shell, you can just pass the correct header with each request
12+
curl "https://yourdomain.com/wp-json/fluent-crm/v2/subscribers" \
13+
-H "Authorization: BASIC API_USERNAME:API_PASSWORD"
14+
```
15+
16+
**API Base URL:** `https://yourdomain.com/wp-json/fluent-crm/v2`
17+
18+
### Creating API Key
19+
You can either create Application Password using WordPress's user editing Page. Please make sure, the user have access to FluentCRM.
20+
We recommend creating Application Password from inside FluentCRM. Navigate to `FluentCRM -> Settings -> Managers` and then create a Manager First. Please make sure the manager is not "Administrator" user role. Select the permissions you want to give to that user for FluentCRM.
21+
22+
![Create manager on FluentCRM](images/create_manager.png)
23+
24+
Then Go to `FluentCRM -> Settings > Rest API` and Create the new key corresponding to manager.
25+
26+
![Rest API Screen](images/rest_api_screen.png)
27+
28+
Once you confirm, It will give you the username and application password. Please note that, You can not retrive the Application password later. So save that for the future use.
29+
30+
![Application Create Success](images/rest_api_success_keys.png)
31+
32+
In the background, FluentCRM create REST API in WordPress user.
33+
34+
35+
> Make sure to replace `API_USERNAME` & `API_PASSWORD` with your UserName & API Password.

0 commit comments

Comments
 (0)