Added getting started and authentication page by MutiatBash · Pull Request #224 · mautic/developer-documentation-new

MutiatBash · 2024-10-23T19:54:10Z

No description provided.

RCheesley

Thanks for the PR @MutiatBash - I've made a few comments but proper reviewing is blocked by #225 which is required to unblock building locally. I'm also noticing that Vale isn't checking this page correctly so we might need to check that, too.

docs/rest_api/getting_started.rst

RCheesley

@MutiatBash a small Vale fix here, too.

docs/rest_api/authentication.rst

MutiatBash · 2024-10-25T22:34:58Z

@RCheesley .....I've made the suggested changes, can you review them

RCheesley

Thanks for the great work @MutiatBash - just a few small tweaks to fix then it should be good to merge!

docs/rest_api/authentication.rst

docs/rest_api/getting_started.rst

RCheesley · 2024-11-12T13:07:58Z

Hi @MutiatBash give us a shout when you're ready for a re-review - it's helpful if you can mark the conversation resolved once you fix each item. Thanks!

RCheesley

Couple of small points to address with this one.

docs/rest_api/authentication.rst

RCheesley · 2026-01-19T18:14:09Z

When this goes to 7 let's ensure we add an admonition about API v2 on the getting started page. Also, can we ensure this is first in the TOC, or near the top?

Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>

adiati98 · 2026-01-20T10:53:17Z

When this goes to 7 let's ensure we add an admonition about API v2 on the getting started page. Also, can we ensure this is first in the TOC, or near the top?

The Getting Started page is to get started with API. It's already on the top of TOC of REST API. I don't think if we move this to the top of TOC (above Development Environment), it'll make sense.
Can you please suggest a copy for admonition for API V2? I'm not sure what to point here. Do we want to point that we now have V2 or something else?

adiati98 · 2026-01-21T08:51:25Z

@mautic/core-team I'd like to confirm some things.

Getting started

The "Getting started" page in this PR is combinations of the below legacies:

There's one thing here:

The Libraries is now a note admonition in the page, where we point folks to the api-library repository. In other word, the Libraries page is skipped. Do we want this?

Here's the link to the live preview: https://mautic-developer--224.org.readthedocs.build/en/224/rest_api/getting_started.html

Authentication

The "Authentication" page in this PR is combinations of the below legacies:

There are several things here:

Should we keep "Authorization" as title, or are we okay with "Authentication"? But we might need to be consistence here. Because one of the subsections in the legacy is Basic Authentication. We might want to review when to use which one.
The OAuth 1a section is skipped. Do we still need this? If so, we need to put it back here.
The contents are slightly different with the original. Perhaps to update things as they're now combined? However, I can't confirm if they're valid, as some subsections are new. Therefore, I need you to review the content.

Here's the link to the live preview: https://mautic-developer--224.org.readthedocs.build/en/224/rest_api/authentication.html

TIA! ✨

adiati98 · 2026-01-21T08:52:28Z

docs/rest_api/authentication.rst

+.. code-block:: php
+
+   <?php
+
+   use GuzzleHttp\Client;
+   use Mautic\Auth\ApiAuth;
+   use Mautic\MauticApi;
+
+   // Initiate an HTTP Client
+   $httpClient = new Client([
+       'timeout'  => 10,
+   ]);
+
+   // Initiate the auth object
+   $settings = [
+       'userName' => 'YOUR_USERNAME',
+       'password' => 'YOUR_PASSWORD'
+   ];
+   $apiUrl = 'https://mautic.example.com';
+
+   $initAuth = new ApiAuth($httpClient);
+   $auth     = $initAuth->newAuth($settings, 'BasicAuth');
+
+   $api         = new MauticApi();
+   $contactsApi = $api->newApi('contacts', $auth, $apiUrl);
+   $contacts    = $contactsApi->getList();


@mautic/core-team I don't see this code-block anywhere in the legacy docs. Is this valid?

I think we can just link to https://github.com/mautic/api-library?tab=readme-ov-file#installing-the-api-library which will always have the up to date example?

MutiatBash added 2 commits October 23, 2024 19:30

Added getting started and authentication page

e161ab7

Updated Symfony Cache Link

c38b66b

MutiatBash mentioned this pull request Oct 23, 2024

Add getting started page to API documentation and add more to the Postman collection #217

Open

2 tasks

RCheesley requested changes Oct 24, 2024

View reviewed changes

RCheesley added 2 commits October 24, 2024 10:34

Merge branch '5.x' into rest-api-getting-started-page

dbb11a1

Merge branch '5.x' into rest-api-getting-started-page

af4c574

RCheesley requested changes Oct 24, 2024

View reviewed changes

docs/rest_api/authentication.rst Outdated Show resolved Hide resolved

RCheesley added documentation Improvements or additions to documentation pending-feedback labels Oct 24, 2024

updated getting started and authentication page

4e0def7

RCheesley requested changes Oct 29, 2024

View reviewed changes

Rest API : updated getting started and authentication page

08ce05a

RCheesley added the hacktoberfest-accepted label Oct 31, 2024

adiati98 added 2 commits July 13, 2025 19:19

Merge branch '5.x' into rest-api-getting-started-page

d73847c

Merge branch '5.x' into rest-api-getting-started-page

14cdaea

adiati98 requested a review from a team as a code owner January 11, 2026 09:16

adiati98 requested review from adiati98 and favour-chibueze and removed request for a team January 11, 2026 09:16

adiati98 and others added 4 commits January 16, 2026 13:21

Merge branch '5.x' into rest-api-getting-started-page

aff5de9

adjust wordings and address vale warnings

69e52d4

add REST to accept.txt

b41b1fd

adjust wordings and address vale warnings

d4e567c

RCheesley requested changes Jan 19, 2026

View reviewed changes

docs/rest_api/authentication.rst Outdated Show resolved Hide resolved

docs/rest_api/authentication.rst Outdated Show resolved Hide resolved

adiati98 and others added 2 commits January 20, 2026 07:29

Merge branch '5.x' into rest-api-getting-started-page

8503768

Apply suggestions from code review

5a83c08

Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>

adiati98 reviewed Jan 21, 2026

View reviewed changes

adiati98 added this to Mautic's No/Low/Code Tasks Jan 25, 2026

adiati98 moved this to 🔎 In review in Mautic's No/Low/Code Tasks Jan 25, 2026

adiati98 moved this from 🔎 In review to 🕰️ In progress in Mautic's No/Low/Code Tasks Feb 5, 2026

Conversation

MutiatBash commented Oct 23, 2024

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MutiatBash commented Oct 25, 2024

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RCheesley commented Nov 12, 2024

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RCheesley commented Jan 19, 2026

Uh oh!

adiati98 commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adiati98 commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Getting started

Authentication

Uh oh!

adiati98 Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

escopecz Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

adiati98 commented Jan 20, 2026 •

edited

Loading

adiati98 commented Jan 21, 2026 •

edited

Loading