swagger.json

{
    "swagger": "2.0",
    "info": {
        "title": "GetResponse Content Gateway API",
        "description": "API za pomoc\u0105 kt\u00f3rego mo\u017cna komunikowa\u0107 si\u0119 z serwisami ukrytymi za VPN.",
        "contact": {
            "name": "GetResponse Digital Marketing Systems Team",
            "email": "grdms@etresponse.com"
        },
        "version": "1.0.0"
    },
    "host": "content-gateway.int.getresponse.com",
    "basePath": "/",
    "schemes": [
        "https"
    ],
    "paths": {
        "/help/v1/categories": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Wy\u015bwietla list\u0119 kategorii",
                "description": "Zwraca lisst\u0119 wszystkich kategorii z subkategoriami z helpa.",
                "produces": [
                    "application/json"
                ],
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Brak zawarto\u015bci do zwr\u00f3cenia."
                    }
                }
            }
        },
        "/help/v1/categories/{slug}": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Wy\u015bwietla konkretn\u0105 kategori\u0119 podan\u0105 za pomoc\u0105 parametru slug.",
                "description": "Zwraca konkretn\u0105 kategori\u0119.",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "description": "Slug konkretnej kategorii.",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Wybrana kategoria istnieje, ale nie zwraca \u017cadnej zawarto\u015bci."
                    }
                }
            }
        },
        "/help/v1/page": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Zwraca spersonalizowany zestaw danych dotycz\u0105cych helpa.",
                "description": "Zwraca zawarto\u015b\u0107 wybranych zasob\u00f3w zapisuj\u0105c w cache osobno ka\u017cdy z nich. Do wyboru mamy kilka parametr\u00f3w, kt\u00f3re mo\u017cna u\u017cy\u0107 i zostan\u0105 obs\u0142u\u017cone. S\u0105 to: lista kategorii, 5 ostatnich post\u00f3w, top 5 pot\u00f3w, searchPage, homePage, webinarsHomePage",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "resources",
                        "in": "query",
                        "description": "Jest to lista zasob\u00f3w kt\u00f3re s\u0105 do pobrania. Ka\u017cdy zas\u00f3b, kt\u00f3ry chcemy by zosta\u0142 pobrany, musi by\u0107 oddzielony za pomoc\u0105 przecinka. Ka\u017cdy z tych zasob\u00f3w zostanie osobno wrzucony do mechanizmu cache..",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Brak zawarto\u015bci do zwr\u00f3cenia."
                    }
                }
            }
        },
        "/help/v1/glossaries": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Wy\u015bwietla wpisy s\u0142ownika",
                "description": "Zwraca pe\u0142n\u0105 list\u0119 wpis\u00f3w s\u0142ownika lub 5 ostatnich wpis\u00f3w",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "top",
                        "in": "query",
                        "description": "Aktualnie parametr top jest zdefiniowany tak, aby zwraca\u0142 5 wpis\u00f3w.ements to respond. W przysz\u0142ych wydaniach API ten parametr b\u0119dzie mo\u017cna modyfikowa\u0107 wedle potrzeb.",
                        "required": false,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Wybrany wpis s\u0142ownika istnieje, ale nie posiada zawarto\u015bci."
                    },
                    "404": {
                        "description": "Wybrany wpis s\u0142ownika nie istnieje."
                    }
                }
            }
        },
        "/help/v1/languages": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Lista dost\u0119pnych j\u0119zyk\u00f3w w helpie.",
                "description": "Zwraca list\u0119 wszystkich dost\u0119pnych j\u0119zyk\u00f3w w helpie.",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Wybrany j\u0119zyk istnieje, ale nie posiada zawarto\u015bci"
                    },
                    "404": {
                        "description": "Nie odnaleziono wybranego j\u0119zyka"
                    }
                }
            }
        },
        "/help/v1/posts/{slug}": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Wyszukaj post po jego slugu",
                "description": "Zwraca pojedy\u0144czy post po wpisaniu jego sluga.",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "description": "Slug - odpowiednio spreparowany tytu\u0142 postu.",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Post istnieje, ale nie posiada zawarto\u015bci"
                    },
                    "404": {
                        "description": "Nie odnaleziono postu."
                    }
                }
            }
        },
        "/help/v1/posts": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Wyszukaj posty za pomoc\u0105 wybranych parametr\u00f3w",
                "description": "Zwraca list\u0119 post\u00f3w w zale\u017cno\u015bci od podanego parametru. Top 5 lub 5 ostatnio dodanych post\u00f3w.",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "top",
                        "in": "query",
                        "description": "Top 5 post\u00f3w. W przysz\u0142o\u015bci b\u0119dzie mo\u017cna samodzielnie wybra\u0107 ilo\u015b\u0107 post\u00f3w do wyszukania.",
                        "required": false,
                        "type": "integer"
                    },
                    {
                        "name": "last",
                        "in": "query",
                        "description": "Pi\u0119\u0107 ostatnio dodanych post\u00f3w.",
                        "required": false,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Znalezione posty nie posiadaj\u0105 zawarto\u015bci."
                    },
                    "404": {
                        "description": "Nie znaleziono post\u00f3w o takich kryteriach."
                    }
                }
            }
        },
        "/help/v1/posts/drafts": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Zwraca drafty post\u00f3w.",
                "description": "Zwraca post ze statusem draft.",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "description": "ID postu.",
                        "required": true,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successfull operation."
                    },
                    "204": {
                        "description": "Draft exists but response has no content"
                    },
                    "404": {
                        "description": "Draft not found"
                    }
                }
            }
        },
        "/help/v1/redirect": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Pobierz list\u0119 redirect\u00f3w.",
                "description": "Zwraca list\u0119 redirect\u00f3w w helpie.",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Brak zawarto\u015bci"
                    },
                    "404": {
                        "description": "Nie odnaleziono redirect\u00f3w."
                    }
                }
            }
        },
        "/help/v1/taglines": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Zwraca tagline.",
                "description": "Zwraca aktualn\u0105 liste tagline, kt\u00f3ra zosta\u0142a ustawiona w helpie.",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Zapytanie poprawnie wykonane, ale nie ma tre\u015bci do zwr\u00f3cenia."
                    },
                    "404": {
                        "description": "Nie odnaleziono taglines."
                    }
                }
            }
        },
        "/help/v1/webinars": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Zwraca list\u0119 webinar\u00f3w opublikowanych.",
                "description": "Zwraca wszystkie webinary, kt\u00f3re s\u0105 opublikowane.",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Istniej\u0105 szukane webinary, ale nie posiadaj\u0105 zawarto\u015bci."
                    },
                    "404": {
                        "description": "Nie odnaleziono webinar\u00f3w."
                    }
                }
            }
        },
        "/help/v1/webinars/drafts": {
            "get": {
                "tags": [
                    "Help"
                ],
                "summary": "Wyszukaj webinary ze statusem draft.",
                "description": "Zwraca list\u0119 webinar\u00f3w ze statusem draft.",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Udana operacja."
                    },
                    "204": {
                        "description": "Brak zawarto\u015bci do zwr\u00f3cenia."
                    },
                    "404": {
                        "description": "Nie odnaleziono takich webinar\u00f3w."
                    }
                }
            }
        },
        "/marketplace/v1/posts/{slug}": {
            "get": {
                "tags": [
                    "Marketplace"
                ],
                "summary": "Find posts by slug",
                "description": "It returns a single post by slug",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "description": "A slug.",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successfull operation."
                    },
                    "204": {
                        "description": "Post exists but response has no content"
                    }
                }
            }
        },
        "/v1/token": {
            "post": {
                "parameters": [
                    {
                        "name": "grant_type",
                        "in": "body",
                        "description": "grant_type=client_credentials",
                        "required": true,
                        "schema": {
                            "$ref": "#/SecurityScheme/AddCustomSubjectLinePayload"
                        }
                    },
                    {
                        "name": "client_id",
                        "in": "body",
                        "description": "User name",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/AddCustomSubjectLinePayload"
                        }
                    },
                    {
                        "name": "client_secret",
                        "in": "body",
                        "description": "WP Host",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/AddCustomSubjectLinePayload"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Return access token"
                    },
                    "403": {
                        "description": "Access denied"
                    }
                }
            }
        }
    },
    "definitions": {},
    "securityDefinitions": {
        "Bearer": {
            "type": "apiKey",
            "name": "Authorization",
            "in": "header"
        }
    },
    "tags": [
        {
            "name": "Help",
            "description": "Spis wszystkich metod API dla komunikacji z serwisem Help."
        },
        {
            "name": "Marketplace",
            "description": "Spis wszystkich metod API dla komunikacji z serwisem Marketplace."
        },
        {
            "name": "Common",
            "description": "Spis wszystkich metod API dla komunikacji z serwisem Common."
        }
    ]
}