api-client-python icon indicating copy to clipboard operation
api-client-python copied to clipboard

Update documentation landing page

Open Frozenn-X opened this issue 10 months ago • 0 comments

After 6 years, the current python api documentation does not reflect the current state of the api and does not provide access to all the information required for proper development:

Essential parameters such as 'redirect_url' and 'capture_crendentials' are missing.

Here's an example:

Image

Here a code wich show we can create a correct page with redirect & capture credentials : ps : we can imagine if u pass 'capture_passwords=True' the api take care to you capture (needed to try it)

my_key = "keyGofish"
api = Gophish(my_key, host=you_host, verify=False) 
page = Page(
            name=f"{your_name)", 
            html=f"{your_html}",
            redirect_url="redirect/url",
            capture_credentials=True)

currently return :

  {
    "id": id,
    "name": you_name,
    "html": your_html
    "modified_date": "2025-03-17T10:24:40.167224+00:00",
    "capture_credentials": true,
    "capture_passwords": false,
    "redirect_url": "redirect/url"
  }

Frozenn-X avatar Mar 17 '25 10:03 Frozenn-X