Ssibrahimbas location-app

With this API you can currently add, list, filter, delete and update countries and cities.

Endpoints

Create Country

You can add country with this endpoint.

Parameters

Parameter	Is Required	Type
name	true	string
langCode	true	string

Returns

is success

{
  "success": true,
  "message": "Country successfully created"
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "name",
         "message": "name field is required"
      }
   ]
}

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

Example Requests

look at requests folder for example requests.

Update Country

You can update country with this endpoint.

Parameters

Parameter	Is Required	Type
name	false	string
langCode	false	string

Note: you just have to submit the field you want to update. If the name and langCode are not sent at the same time, an error will be returned.

Returns

is success

{
  "success": true,
  "message": "Country successfully updated"
}

Not Changed

{
   "success": false,
   "message": "Change not detected."
}

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

Example Requests

look at requests folder for example requests.

Get Country

You can get country with this endpoint.

Parameters

Parameter	Is Required	Type
id	true	integer

Returns

is success

{
  "success": true,
  "message": "Country successfully fetched",
  "data": {
    "id": 1,
    "name": "Ukraine",
    "langCode": "uk-UA"
  }
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "id",
         "message": "id field is required"
      }
   ]
}

Example Requests

look at requests folder for example requests.

GetAll Country

You can get all countries with this endpoint.

Parameters

Parameter	Is Required	Type	Default
page	false	integer	1
limit	false	integer	20
order	false	string	name
sort	false	string	desc
filter	false	string	-

Returns

is success

{
  "success": true,
  "message": "Countries successfully fetched",
  "data": {
    "page": 2,
    "limit": 20,
    "countries": [
      {
        "id": 2,
        "name": "Ukraine",
        "langCode": "uk-UA"
      },
      {
        "id": 3,
        "name": "Turkey",
        "langCode": "tr-TR"
      }
    ]
  }
}

Example Requests

look at requests folder for example requests.

Delete Country

You can delete country with this endpoint.

Parameters

Parameter	Is Required	Type
id	true	integer

Returns

is success

{
  "success": true,
  "message": "Country successfully deleted"
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "id",
         "message": "id field is required"
      }
   ]
}

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

Example Requests

look at requests folder for example requests.

Create City

You can add city with this endpoint.

Parameters

Parameter	Is Required	Type
name	true	string
plateCode	true	number
countryId	true	number

Returns

is success

{
  "success": true,
  "message": "City successfully created"
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "name",
         "message": "name field is required"
      }
   ]
}

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

Example Requests

look at requests folder for example requests.

Update City

You can update city with this endpoint.

Parameters

Parameter	Is Required	Type
name	false	string
plateCode	false	number

Note: you just have to submit the field you want to update. If the name and plateCode are not sent at the same time, an error will be returned.

Returns

is success

{
  "success": true,
  "message": "City successfully updated"
}

Not Changed

{
   "success": false,
   "message": "Change not detected."
}

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

Example Requests

look at requests folder for example requests.

Get City

You can get city with this endpoint.

Parameters

Parameter	Is Required	Type
id	true	integer

Returns

is success

{
  "success": true,
  "message": "City successfully fetched",
  "data": {
      "cityId": 1,
      "cityName": "Istanbul",
      "countryId": 1,
      "plateCode": 34,
      "countryName": "Turkey",
      "langCode": "tr-TR"
  }
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "id",
         "message": "id field is required"
      }
   ]
}

Example Requests

look at requests folder for example requests.

GetAll Cities

You can get all cities with this endpoint.

Parameters

Parameter	Is Required	Type	Default
page	false	integer	1
limit	false	integer	20
order	false	string	name
sort	false	string	desc
filter	false	string	-
countryId	false	number	-

Returns

is success

{
  "success": true,
  "message": "Cities successfully fetched",
  "data": {
      "page": 1,
      "limit": 20,
      "cities": [
          {
              "cityId": 1,
              "cityName": "İstanbul",
              "plateCode": 34,
              "countryId": 1,
              "countryName": "Turkey",
              "langCode": "tr-TR"
          },
          {
              "cityId": 2,
              "cityName": "Ankara",
              "plateCode": 6,
              "countryId": 1,
              "countryName": "Turkey",
              "langCode": "tr-TR"
          }
      ]
}

Example Requests

look at requests folder for example requests.

Delete City

You can delete city with this endpoint.

Parameters

Parameter	Is Required	Type
id	true	integer

Returns

is success

{
  "success": true,
  "message": "City successfully deleted"
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "id",
         "message": "id field is required"
      }
   ]
}

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

Example Requests

look at requests folder for example requests.

You can get register to this app with this endpoint.

Parameters

Parameter	Is Required	Type	Default
email	false	string	[email protected]
password	false	string	12345

Returns

is success

{
  "success": true,
  "message": "User register successfully"
}

already exists

{
    "success": false,
    "message": "User already exists."
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "email",
         "message": "email field is required"
      },
      {
         "field": "password",
         "message": "password field is required"
      }
   ]
}

You can get login to this app with this endpoint.

Parameters

Parameter	Is Required	Type	Default
email	false	string	[email protected]
password	false	string	12345

Returns

is success

{
    "success": true,
    "message": "Successfully logged in",
    "data": {
        "email": "[email protected]",
        "createdAt": "2022-03-27"
    }
}

not found

{
    "success": false,
    "message": "User not found."
}

Validation Error

{
   "success": false,
   "message": "Validation Error",
   "data": [
      {
         "field": "email",
         "message": "email field is required"
      },
      {
         "field": "password",
         "message": "password field is required"
      }
   ]
}

Log Out

You can get log out from this app with this endpoint.

Returns

Authorization Error

{
    "success": false,
    "message": "You must be logged in to access this page"
}

is success

{
    "success": true,
    "message": "Successfully Signed out"
}

Here are few exercises to practice how to implement API Security with NGINX App-Protect WAF.

api-security-lab This repo contains files for customers and partners to practice an API Security with NGINX App-Protect WAF. To demonstrate the capabi

4 Mar 30, 2022

PHP project for tracking Azure AD App Reg secrets about to expire, and (manually) tracking SSL certificates

CertExpiry Katy Nicholson https://katystech.blog/ Setup instructions etc available at: https://katystech.blog/2021/11/certexpiry/ PHP project for trac

5 Oct 2, 2022

Simple class that implement a CAPTCHA for your PHP App.

simple-captcha Simple class that implement a CAPTCHA for your PHP App. Installation Use the package manager composer to install. composer require will

3 Nov 9, 2022

Web app for kick session in a server 1C use rac/ras

Server requirement OS: Ubuntu 20.04 Usage Update adm1c nano adm1c You should change server_name adm1c.example.com to your name Update index.php nano

10 Dec 5, 2022

Static Web App to train Filipinos in using MS Word with the use of Filipino language

MS Word Filipino Isang static web application na layuning magturo ng paggamit ng MS Word sa wikang Filipino. Ito ay isang proyekto na bahagi ng panana

2 Sep 30, 2022

crm_chatbot is an app which allows to create a chat for websites.

CRM Chatbot This app could be installed only in the Midrub CMS version 0.0.8.5+. In older versions it will break anything. DEMO VIDEO: https://youtu.b

2 Oct 27, 2022

Perch Dashboard app for exporting content to (Kirby) text files and Kirby Blueprint files

toKirby Perch Dashboard app for exporting content to (Kirby) text files and Kirby Blueprint files. You can easily install and test it in a few steps.

4 Jan 15, 2022

🔖 Bookmark app for Nextcloud

Nextcloud Bookmarks Bookmarks app for Nextcloud This app provides you with a web interface for collecting and organizing bookmarks to the places on th