From f25bb7da354ee0eadcd8883659005b3d6bf7f067 Mon Sep 17 00:00:00 2001 From: dreeyy <104018470+dreeyy@users.noreply.github.com> Date: Sun, 24 Apr 2022 22:05:21 -0300 Subject: [PATCH] Update README.md --- README.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 4de0975..8277039 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,12 @@ -# Introduction +# Documentation Product Catalog api -Gophish was built from the ground-up with a JSON API that makes it easy for developers and sysadmins to automate simulated phishing campaigns. +base ulr: https://catalog-product-dafiti.herokuapp.com/ -These docs describe how to use the [Gophish](https://getgophish.com) API. We hope you enjoy these docs, and please don't hesitate to [file an issue](https://github.com/gophish/gophish/issues/new) if you see anything missing. -{% hint style="info" %} -**Is Python your language of choice?** If so, we have a [fully-supported Python API client](https://docs.getgophish.com/python-api-client/) that makes working with the Gophish API a piece of cake! -{% endhint %} - -## Use Cases - -There are many reasons to use the Gophish API. The most common use case is to gather report information for a given campaign, so that you can build custom reports in software you're most familiar with, such as Excel or Numbers. - -However, automating the creation of campaigns and campaign attributes such as templates, landing pages, and more provides the ability to create a fully automated phishing simulation program. This would allow campaigns to be run throughout the year automatically. This also allows the Gophish administrator to be included in the campaigns, since they wouldn't know exactly which day it would start! - -## Authorization - -All API requests require the use of a generated API key. You can find your API key, or generate a new one, by navigating to the /settings endpoint, or clicking the “Settings” sidebar item. - -To authenticate an API request, you should provide your API key in the `Authorization` header. - -Alternatively, you may append the `api_key=[API_KEY]` as a GET parameter to authorize yourself to the API. But note that this is likely to leave traces in things like your history, if accessing the API through a browser. +## Product ```http -GET /api/campaigns/?api_key=12345678901234567890123456789012 +POST /create-product/ ``` | Parameter | Type | Description |