{
    "variables": [],
    "info": {
        "name": "Portalz API - REST API for real estate portals",
        "_postman_id": "3b786c9d-71ff-4c94-bfd3-75678b58e321",
        "description": "",
        "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
    },
    "item": [
        {
            "name": "Portals",
            "description": "\nAPIs for managing portals",
            "item": [
                {
                    "name": "GET all portals",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "api\/v1\/portals",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/api\/v1\/portals"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "This endpoint gets all avaliable portals. No pagination needed.",
                        "response": []
                    }
                },
                {
                    "name": "GET locale portals",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "api\/v1\/portals\/{locale:[A-Z]{2}}",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/api\/v1\/portals\/{locale:[A-Z]{2}}"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "This endpoint gets specified locale portals.\n<aside class=\"notice\">Scribe is buggy, so example request to the right should be: https:\/\/portalz.b01.de\/api\/v1\/portals\/FR<\/aside>",
                        "response": []
                    }
                },
                {
                    "name": "GET single portal",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "api\/v1\/portals\/{id:[0-9]+}",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/api\/v1\/portals\/{id:[0-9]+}"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "",
                        "response": []
                    }
                },
                {
                    "name": "POST portal",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "api\/v1\/portals",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/api\/v1\/portals"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Authorization",
                                "value": "Bearer c36Vbg86f5ad1eZkPDv4hEa"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"title\": \"unde\",\n    \"import\": 0,\n    \"export\": 1,\n    \"interface\": \"openimmo,kyero\",\n    \"url\": \"https:\\\/\\\/www.prime-real.de\",\n    \"description\": \"ex\",\n    \"server\": \"ftp.prime-real.de\",\n    \"locale\": \"DE,EN\",\n    \"cnt\": 13\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "When posting a portal you automatically become owner",
                        "response": []
                    }
                },
                {
                    "name": "DELETE portal",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "api\/v1\/portals\/:id",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/api\/v1\/portals\/:id"
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Authorization",
                                "value": "Bearer 4Z5gPDh1da36Ekvb8Vcfea6"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "Delete portal. Only possible if admin.",
                        "response": []
                    }
                },
                {
                    "name": "PUT portal",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "api\/v1\/portals\/:id",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/api\/v1\/portals\/:id"
                        },
                        "method": "PUT",
                        "header": [
                            {
                                "key": "Authorization",
                                "value": "Bearer Z1faVcD8g365ah4Pbd6evEk"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "Update portal. Only possible if owner or admin.",
                        "response": []
                    }
                }
            ]
        },
        {
            "name": "Users",
            "description": "\nAPIs for managing users",
            "item": [
                {
                    "name": "Register",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "auth\/register",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/auth\/register"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"name\": \"hans meiser\",\n    \"email\": \"hans@meiser.com\",\n    \"password\": \"123456\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "Register a new user and get a token. User can publish a new portal.",
                        "response": []
                    }
                },
                {
                    "name": "Login",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "auth\/login",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/auth\/login"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"email\": \"hans@meiser.com\",\n    \"password\": \"123456\\n\\nGet a JWT via given credentials.\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "",
                        "response": []
                    }
                },
                {
                    "name": "Logout",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "auth\/logout",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/auth\/logout"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Authorization",
                                "value": "Bearer PEbk681dahZDfv3ge54Vca6"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "Log the user out (Invalidate the token).",
                        "response": []
                    }
                },
                {
                    "name": "Refresh token",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "auth\/refresh",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/auth\/refresh"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Authorization",
                                "value": "Bearer 6va8PdDaZ43gke6b5EcVf1h"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "Get new token.",
                        "response": []
                    }
                },
                {
                    "name": "Get User",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "portalz.b01.de",
                            "path": "auth\/me",
                            "query": [],
                            "raw": "http:\/\/portalz.b01.de\/auth\/me"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Authorization",
                                "value": "Bearer bPgEfhaav6c6Vd8543De1Zk"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "[]",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "description": "Get the authenticated User.",
                        "response": []
                    }
                }
            ]
        }
    ]
}