Browse Source

Add postman collection.

master
Anand Shukla 8 months ago
parent
commit
35e0cd663f
  1. 697
      EKIKA Easy API Framework.postman_collection.json
  2. BIN
      assets/api-framework-bundle.png
  3. BIN
      assets/postman-ss.png

697
EKIKA Easy API Framework.postman_collection.json

@ -0,0 +1,697 @@
{
"info": {
"_postman_id": "45f10b98-2b65-4792-b70b-4c915227ea81",
"name": "EKIKA Easy API Framework",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "32730312"
},
"item": [
{
"name": "JsonAPI",
"item": [
{
"name": "JsonAPI Easy API CRUD With API Key",
"item": [
{
"name": "READ",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "x-api-key",
"value": "*SFde+7A`F)YV<pZ?RNJ1@n|erAPDPCL",
"type": "text"
}
],
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-apikey/res.partner?fields[res.partner]=name,is_company,email,phone,country_id,user_id,company_id&fields[res.country]=name,code&fields[res.users]=name,active&include=country_id,user_id,company_id&fields[res.company]=name&page[number]=1&page[size]=5&sort=name,-id&filter=[('is_company', '=', true)]",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-apikey",
"res.partner"
],
"query": [
{
"key": "fields[res.partner]",
"value": "name,is_company,email,phone,country_id,user_id,company_id"
},
{
"key": "fields[res.country]",
"value": "name,code"
},
{
"key": "fields[res.users]",
"value": "name,active"
},
{
"key": "include",
"value": "country_id,user_id,company_id"
},
{
"key": "fields[res.company]",
"value": "name"
},
{
"key": "page[number]",
"value": "1"
},
{
"key": "page[size]",
"value": "5"
},
{
"key": "sort",
"value": "name,-id"
},
{
"key": "filter",
"value": "[('is_company', '=', true)]"
}
]
}
},
"response": []
},
{
"name": "READ Single Record",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "x-api-key",
"value": "*SFde+7A`F)YV<pZ?RNJ1@n|erAPDPCL",
"type": "text"
}
],
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-apikey/res.partner/33?fields[res.partner]=name,is_company,email,phone,country_id,user_id,company_id&fields[res.country]=name,code&fields[res.users]=name,active&include=country_id,user_id,company_id&fields[res.company]=name",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-apikey",
"res.partner",
"33"
],
"query": [
{
"key": "fields[res.partner]",
"value": "name,is_company,email,phone,country_id,user_id,company_id"
},
{
"key": "fields[res.country]",
"value": "name,code"
},
{
"key": "fields[res.users]",
"value": "name,active"
},
{
"key": "include",
"value": "country_id,user_id,company_id"
},
{
"key": "fields[res.company]",
"value": "name"
}
]
}
},
"response": []
},
{
"name": "CREATE",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "x-api-key",
"value": "*SFde+7A`F)YV<pZ?RNJ1@n|erAPDPCL",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"res.partner\",\n \"attributes\": {\n \"active\": true,\n \"name\": \"Ekika Corporation\",\n \"company_type\": \"company\",\n \"city\": \"Gandhinagar\",\n \"street\": \"Gandhinagar\",\n \"zip\": \"382421\",\n \"comment\": \"<p>Comment Here</p>\",\n \"phone\": \"5554444555444\",\n \"mobile\": \"1010101\",\n \"website\": \"http://www.ekika.co\",\n \"email\": \"hello@ekika.co\"\n },\n \"relationships\": {\n \"category_id\": {\n \"data\": [\n {\n \"type\": \"res.partner.category\",\n \"id\": \"4\"\n },\n {\n \"type\": \"res.partner.category\",\n \"id\": \"3\"\n }\n ]\n },\n \"bank_ids\":{\n \"data\": [\n {\n \"type\": \"res.partner.bank\",\n \"attributes\": {\n \"sequence\": 10,\n \"bank_id\": 2,\n \"acc_number\": \"11212121212\",\n \"allow_out_payment\": true,\n \"acc_holder_name\": false\n }\n },\n {\n \"type\": \"res.partner.bank\",\n \"attributes\": {\n \"sequence\": 11,\n \"bank_id\": 3,\n \"acc_number\": \"3434343434343434\",\n \"allow_out_payment\": true,\n \"acc_holder_name\": false\n }\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-apikey/res.partner",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-apikey",
"res.partner"
]
}
},
"response": []
},
{
"name": "UPDATE",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "x-api-key",
"value": "*SFde+7A`F)YV<pZ?RNJ1@n|erAPDPCL",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"res.partner\",\n \"id\": 53,\n \"attributes\": {\n \"active\": true,\n \"name\": \"Ekika Corporation Pvt Ltd.\",\n \"company_type\": \"company\",\n \"city\": \"Gandhinagar\",\n \"street\": \"Gandhinagar\",\n \"zip\": \"000000\",\n \"comment\": \"<p>Comment Here</p>\",\n \"phone\": \"5554444555444\",\n \"mobile\": \"1010101\",\n \"website\": \"http://www.ekika.co\",\n \"email\": \"hello@ekika.co\"\n },\n \"relationships\": {\n \"category_id\": {\n \"data\": []\n },\n \"bank_ids\":{\n \"data\": []\n }\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-apikey/res.partner/53",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-apikey",
"res.partner",
"53"
]
}
},
"response": []
},
{
"name": "DELETE",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "x-api-key",
"value": "*SFde+7A`F)YV<pZ?RNJ1@n|erAPDPCL",
"type": "text"
}
],
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-apikey/res.partner/53",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-apikey",
"res.partner",
"53"
]
}
},
"response": []
}
]
},
{
"name": "JsonAPI Easy API With API User Auth",
"item": [
{
"name": "READ",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "username",
"value": "hello@ekika.co",
"type": "text"
},
{
"key": "password",
"value": "hello-ekika",
"type": "text"
}
],
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-apiuser/res.partner?fields[res.partner]=name,email,phone,country_id,user_id,company_id&fields[res.country]=name,code&fields[res.users]=name,active&include=country_id,user_id,company_id&fields[res.company]=name&page[number]=3&page[size]=4&sort=id",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-apiuser",
"res.partner"
],
"query": [
{
"key": "fields[res.partner]",
"value": "name,email,phone,country_id,user_id,company_id"
},
{
"key": "fields[res.country]",
"value": "name,code"
},
{
"key": "fields[res.users]",
"value": "name,active"
},
{
"key": "include",
"value": "country_id,user_id,company_id"
},
{
"key": "fields[res.company]",
"value": "name"
},
{
"key": "page[number]",
"value": "3"
},
{
"key": "page[size]",
"value": "4"
},
{
"key": "sort",
"value": "id"
}
]
}
},
"response": []
}
]
},
{
"name": "JsonAPI Easy API With Basic Auth",
"item": [
{
"name": "READ",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/vnd.api+json",
"type": "text"
},
{
"key": "Authorization",
"value": "basic aGVsbG9AZWtpa2EuY286aGVsbG8tZWtpa2E=",
"type": "text"
}
],
"url": {
"raw": "https://api.17.dev.ekika.co/user-jsonapi-basic/res.partner?fields[res.partner]=name,email,phone,country_id,user_id,company_id&fields[res.country]=name,code&fields[res.users]=name,active&include=country_id,user_id,company_id&fields[res.company]=name&page[number]=3&page[size]=4&sort=id",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-jsonapi-basic",
"res.partner"
],
"query": [
{
"key": "fields[res.partner]",
"value": "name,email,phone,country_id,user_id,company_id"
},
{
"key": "fields[res.country]",
"value": "name,code"
},
{
"key": "fields[res.users]",
"value": "name,active"
},
{
"key": "include",
"value": "country_id,user_id,company_id"
},
{
"key": "fields[res.company]",
"value": "name"
},
{
"key": "page[number]",
"value": "3"
},
{
"key": "page[size]",
"value": "4"
},
{
"key": "sort",
"value": "id"
}
]
}
},
"response": []
}
]
}
]
},
{
"name": "GraphQL",
"item": [
{
"name": "GraphQL Easy API CRUD With API Key",
"item": [
{
"name": "READ",
"request": {
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "^?]hvh&jj][$KN$!RzMs8cJ-`rkKOncO",
"type": "text"
},
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query MyQuery($offset: Int, $limit: Int, $order: String, $domain: [[Any]]) {\n ResPartner(\n offset: $offset\n limit: $limit\n order: $order\n domain: $domain\n )\n {\n id\n name\n phone\n email\n is_company\n country_id{\n name\n code\n }\n user_id{\n name\n active\n }\n company_id{\n name\n }\n }\n}",
"variables": "{\n \"offset\": 0,\n \"limit\": 5,\n \"order\": \"name,id desc\",\n \"domain\": [[\"is_company\",\"=\",true]]\n}"
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-apikey",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-apikey"
]
}
},
"response": []
},
{
"name": "READ Single Record",
"request": {
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "^?]hvh&jj][$KN$!RzMs8cJ-`rkKOncO",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query MyQuery {\n ResPartner(id: \"33\")\n {\n id\n name\n phone\n email\n is_company\n country_id{\n name\n code\n }\n user_id{\n name\n active\n }\n company_id{\n name\n }\n }\n}",
"variables": ""
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-apikey",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-apikey"
]
}
},
"response": []
},
{
"name": "CREATE",
"request": {
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "^?]hvh&jj][$KN$!RzMs8cJ-`rkKOncO",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "mutation Create {\n createResPartner: ResPartner(\n ResPartnerValues: {\n active: true,\n name: \"Ekika Corporation New\",\n category_id: [4, 3]\n company_type: \"company\",\n bank_ids: [\n\t\t\t\t\t[0, 0, {\n\t\t\t\t\t\tsequence: 10,\n\t\t\t\t\t\tbank_id: 2,\n\t\t\t\t\t\tacc_number: \"11212121212\",\n\t\t\t\t\t\tallow_out_payment: true,\n\t\t\t\t\t\tacc_holder_name: false\n\t\t\t\t\t}],\n\t\t\t\t\t[0, 0, {\n\t\t\t\t\t\tsequence: 11,\n\t\t\t\t\t\tbank_id: 3,\n\t\t\t\t\t\tacc_number: \"3434343434343434\",\n\t\t\t\t\t\tallow_out_payment: true,\n\t\t\t\t\t\tacc_holder_name: false\n\t\t\t\t\t}]\n\t\t\t\t]\n city: \"Gandhinagar\",\n street: \"Gandhinagar\",\n street2: \"\",\n zip: \"382421\",\n comment: \"<p>Comment Here</p>\",\n phone: \"5554444555444\",\n mobile: \"1010101\",\n website: \"http://www.ekika.co\",\n email: \"hello@ekika.co\",\n }\n )\n {\n active\n category_id\n bank_ids\n city\n comment\n company_type\n id\n name\n phone\n mobile\n email\n street\n zip\n }\n}",
"variables": ""
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-apikey",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-apikey"
]
}
},
"response": []
},
{
"name": "UPDATE",
"request": {
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "^?]hvh&jj][$KN$!RzMs8cJ-`rkKOncO",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "mutation Update {\n updateResPartner: ResPartner(\n id: 54, \n ResPartnerValues: {\n active: true,\n name: \"Ekika Corporation PVT LTD.\",\n category_id: null\n company_type: \"company\"\n }\n )\n {\n active\n category_id {\n id\n name\n }\n bank_ids {\n id\n }\n city\n comment\n company_type\n id\n name\n phone\n mobile\n email\n street\n zip\n }\n}",
"variables": ""
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-apikey",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-apikey"
]
}
},
"response": []
},
{
"name": "DELETE",
"request": {
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "^?]hvh&jj][$KN$!RzMs8cJ-`rkKOncO",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "mutation Delete {\n deleteResPartner: ResPartner(\n id: 54, \n )\n}",
"variables": ""
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-apikey",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-apikey"
]
}
},
"response": []
}
]
},
{
"name": "GraphQL Easy API With API User Auth",
"item": [
{
"name": "READ",
"request": {
"method": "POST",
"header": [
{
"key": "username",
"value": "hello@ekika.co",
"type": "text"
},
{
"key": "password",
"value": "hello-ekika",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query MyQuery {\n ResPartner{\n name\n phone\n email\n country_id{\n name\n code\n }\n user_id{\n name\n active\n }\n company_id{\n name\n }\n }\n}",
"variables": ""
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-apiuser",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-apiuser"
]
}
},
"response": []
}
]
},
{
"name": "GraphQL Easy API With Basic Auth",
"item": [
{
"name": "READ",
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "basic aGVsbG9AZWtpa2EuY286aGVsbG8tZWtpa2E=",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query MyQuery {\n ResPartner{\n name\n phone\n email\n country_id{\n name\n code\n }\n user_id{\n name\n active\n }\n company_id{\n name\n }\n }\n}",
"variables": ""
}
},
"url": {
"raw": "https://api.17.dev.ekika.co/user-graphql-basic",
"protocol": "https",
"host": [
"api",
"17",
"dev",
"ekika",
"co"
],
"path": [
"user-graphql-basic"
]
}
},
"response": []
}
]
}
]
}
]
}

BIN
assets/api-framework-bundle.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 166 KiB

BIN
assets/postman-ss.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Loading…
Cancel
Save