Flexy API follows the general patterns of REST. You can use the resources of a Flexy account (customer, master.) by making HTTPS requests to URLs that represent those resources. You can find description of all the endpoints here.
\nTo test and explore Flexy API you can use Postman. Postman is a powerful HTTP client for testing RESTful APIs by displaying requests and responses in manageable formats.
\nThe Flexy API uses versioning. This documentation is for version 1.0 of the API. Version must be specified in the base URL, for example: https://{{host}}/openapi/v1/
An application credential is any piece of information that identifies, authenticates, or authorizes an application in some way.
\nFlexy API provide two authorization methods:
\nPersonal access tokens are a simple way to make calls to the API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25985038","collectionId":"90b775e2-0e71-412b-b73d-ef39b1d56c82","publishedId":"2s93ebTrGY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF0000"},"publishDate":"2023-06-11T05:30:12.000Z"},"item":[{"name":"Master","item":[{"name":"Area Province","id":"02d4636c-49fc-4fb0-accb-b47f59d28ec4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/openapi/v1/master/area/provinces","urlObject":{"path":["openapi","v1","master","area","provinces"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d3faa1e6-7a46-46b9-ab95-4591d2c9ff65","name":"200 - SUCCESS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/master/area/provinces"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Trace-Id","value":"c6b79f8e-b280-4435-aae5-6c89d0b4051b"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1753"},{"key":"ETag","value":"W/\"6d9-TsrVeSShqAcO+qGTewOrlKtgeC8\""},{"key":"Date","value":"Thu, 01 Jun 2023 22:48:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"count\": 34,\n \"rows\": [\n {\n \"label\": \"Bali\",\n \"value\": \"Bali\"\n },\n {\n \"label\": \"Bangka Belitung\",\n \"value\": \"Bangka Belitung\"\n },\n {\n \"label\": \"Banten\",\n \"value\": \"Banten\"\n },\n {\n \"label\": \"Bengkulu\",\n \"value\": \"Bengkulu\"\n },\n {\n \"label\": \"DI Yogyakarta\",\n \"value\": \"DI Yogyakarta\"\n },\n {\n \"label\": \"DKI Jakarta\",\n \"value\": \"DKI Jakarta\"\n },\n {\n \"label\": \"Gorontalo\",\n \"value\": \"Gorontalo\"\n },\n {\n \"label\": \"Jambi\",\n \"value\": \"Jambi\"\n },\n {\n \"label\": \"Jawa Barat\",\n \"value\": \"Jawa Barat\"\n },\n {\n \"label\": \"Jawa Tengah\",\n \"value\": \"Jawa Tengah\"\n },\n {\n \"label\": \"Jawa Timur\",\n \"value\": \"Jawa Timur\"\n },\n {\n \"label\": \"Kalimantan Barat\",\n \"value\": \"Kalimantan Barat\"\n },\n {\n \"label\": \"Kalimantan Selatan\",\n \"value\": \"Kalimantan Selatan\"\n },\n {\n \"label\": \"Kalimantan Tengah\",\n \"value\": \"Kalimantan Tengah\"\n },\n {\n \"label\": \"Kalimantan Timur\",\n \"value\": \"Kalimantan Timur\"\n },\n {\n \"label\": \"Kalimantan Utara\",\n \"value\": \"Kalimantan Utara\"\n },\n {\n \"label\": \"Kepulauan Riau\",\n \"value\": \"Kepulauan Riau\"\n },\n {\n \"label\": \"Lampung\",\n \"value\": \"Lampung\"\n },\n {\n \"label\": \"Maluku\",\n \"value\": \"Maluku\"\n },\n {\n \"label\": \"Maluku Utara\",\n \"value\": \"Maluku Utara\"\n },\n {\n \"label\": \"Nanggroe Aceh Darussalam (NAD)\",\n \"value\": \"Nanggroe Aceh Darussalam (NAD)\"\n },\n {\n \"label\": \"Nusa Tenggara Barat (NTB)\",\n \"value\": \"Nusa Tenggara Barat (NTB)\"\n },\n {\n \"label\": \"Nusa Tenggara Timur (NTT)\",\n \"value\": \"Nusa Tenggara Timur (NTT)\"\n },\n {\n \"label\": \"Papua\",\n \"value\": \"Papua\"\n },\n {\n \"label\": \"Papua Barat\",\n \"value\": \"Papua Barat\"\n },\n {\n \"label\": \"Riau\",\n \"value\": \"Riau\"\n },\n {\n \"label\": \"Sulawesi Barat\",\n \"value\": \"Sulawesi Barat\"\n },\n {\n \"label\": \"Sulawesi Selatan\",\n \"value\": \"Sulawesi Selatan\"\n },\n {\n \"label\": \"Sulawesi Tengah\",\n \"value\": \"Sulawesi Tengah\"\n },\n {\n \"label\": \"Sulawesi Tenggara\",\n \"value\": \"Sulawesi Tenggara\"\n },\n {\n \"label\": \"Sulawesi Utara\",\n \"value\": \"Sulawesi Utara\"\n },\n {\n \"label\": \"Sumatera Barat\",\n \"value\": \"Sumatera Barat\"\n },\n {\n \"label\": \"Sumatera Selatan\",\n \"value\": \"Sumatera Selatan\"\n },\n {\n \"label\": \"Sumatera Utara\",\n \"value\": \"Sumatera Utara\"\n }\n ]\n }\n}"}],"_postman_id":"02d4636c-49fc-4fb0-accb-b47f59d28ec4"},{"name":"Area City","id":"e388020c-5313-4bfb-a582-9304e4ad0068","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"province\": \"Riau\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/openapi/v1/master/area/cities","description":"clientType
\ncompanyType
\nbranchType
\n","urlObject":{"path":["openapi","v1","clients","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"fb41c1dd-8c66-4d0c-9320-d47deac7911c","name":"200 - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"a51a7153-6c9e-435d-a810-c1ad9eb917ba\",\r\n \"product_id\": \"8bd8b388-3c6a-44ac-b121-12df9bbf9125\",\r\n \"client\": {\r\n \"name\": \"client 005\",\r\n \"email\": \"client005@mail.com\",\r\n \"tax_number\": \"11111111\",\r\n \"phone_number\": \"081232141231\"\r\n },\r\n \"company\": {\r\n \"name\": \" Test Client 005\",\r\n \"address\": \"Jl. Raya Penggilingan No.77, Penggilingan, Kec. Cakung, Kota Jakarta Timur, Daerah Khusus Ibukota Jakarta 13940\",\r\n \"province\": \"Jawa Barat\",\r\n \"city\": \"Bekasi\",\r\n \"district\": \"Cibitung\",\r\n \"sub_district\": \"Wanasari\",\r\n \"zip_code\": \"17231\",\r\n \"corporate_type_id\": \"6ce194d8-d125-4b38-b8b1-fc3edddf3147\",\r\n \"phone_number\": \"081807778840\",\r\n \"tax_number\": \"433112356002000\",\r\n \"company_type\": \"DISTRIBUTOR\",\r\n \"company_code\": \"FJA\"\r\n },\r\n \"branch\": {\r\n \"name\": \" Test Client 005\",\r\n \"address\": \"Jl. Raya Penggilingan No.77, Penggilingan, Kec. Cakung, Kota Jakarta Timur, Daerah Khusus Ibukota Jakarta 13940\",\r\n \"province\": \"Jawa Barat\",\r\n \"city\": \"Bekasi\",\r\n \"district\": \"Cibitung\",\r\n \"sub_district\": \"Wanasari\",\r\n \"zip_code\": \"17231\",\r\n \"phone_number\": \"081807778840\",\r\n \"tax_number\": \"433112356002000\",\r\n \"branch_type\": \"DISTRIBUTOR\",\r\n \"cogs_method\": \"AVERAGE\",\r\n \"point_converter\": 50000,\r\n \"point_cutoff_period\": \"31-12\",\r\n \"is_head_branch\": true,\r\n \"branch_code\": \"TCHO004\",\r\n \"margin\": 0.0400,\r\n \"non_member\": 0.0300\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/clients/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1798"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Trace-Id","value":"1aae9ae2-ee12-481a-b942-74f206795734"},{"key":"ETag","value":"W/\"706-X0L1zCmlkvayGuYWGWVVagaP5dQ\""},{"key":"Date","value":"Wed, 31 May 2023 09:27:58 GMT"},{"key":"X-Kong-Upstream-Latency","value":"384"},{"key":"X-Kong-Proxy-Latency","value":"2"},{"key":"Via","value":"kong/2.8.1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"client\": {\n \"id\": \"c01cb91e-a970-46a0-9d00-977405aafd13\",\n \"name\": \"client 005\",\n \"email\": \"client005@mail.com\",\n \"phone_number\": \"081232141231\",\n \"tax_number\": \"11111111\",\n \"created_at\": \"2023-05-31T09:27:58.501Z\",\n \"updated_at\": \"2023-05-31T09:27:58.501Z\",\n \"default_password\": \"2yalyc\"\n },\n \"company\": {\n \"id\": \"2f26cf4b-baf6-4f96-bdda-39b7844f645b\",\n \"product_id\": \"8bd8b388-3c6a-44ac-b121-12df9bbf9125\",\n \"industry_id\": \"cc0e3eb7-be78-471d-9643-ffe3df026fb9\",\n \"owner_id\": \"c01cb91e-a970-46a0-9d00-977405aafd13\",\n \"name\": \" Test Client 005\",\n \"address\": \"Jl. Raya Penggilingan No.77, Penggilingan, Kec. Cakung, Kota Jakarta Timur, Daerah Khusus Ibukota Jakarta 13940\",\n \"province\": \"Jawa Barat\",\n \"city\": \"Bekasi\",\n \"district\": \"Cibitung\",\n \"sub_district\": \"Wanasari\",\n \"zip_code\": \"17231\",\n \"corporate_type_id\": \"6ce194d8-d125-4b38-b8b1-fc3edddf3147\",\n \"company_type\": \"DISTRIBUTOR\",\n \"tax_number\": \"433112356002000\",\n \"company_code\": \"FJA\",\n \"phone_number\": \"081807778840\",\n \"created_at\": \"2023-05-31T09:27:58.508Z\",\n \"updated_at\": \"2023-05-31T09:27:58.508Z\",\n \"origin_created\": \"PARTNER\",\n \"package_id\": \"76fc7e5d-642e-48f6-a8bc-9427eaea85ae\"\n },\n \"branch\": {\n \"id\": \"a2dac072-18fc-4dab-a95f-c4efc4d8e2bb\",\n \"company_id\": \"2f26cf4b-baf6-4f96-bdda-39b7844f645b\",\n \"name\": \" Test Client 005\",\n \"address\": \"Jl. Raya Penggilingan No.77, Penggilingan, Kec. Cakung, Kota Jakarta Timur, Daerah Khusus Ibukota Jakarta 13940\",\n \"province\": \"Jawa Barat\",\n \"city\": \"Bekasi\",\n \"district\": \"Cibitung\",\n \"sub_district\": \"Wanasari\",\n \"zip_code\": \"17231\",\n \"phone_number\": \"081807778840\",\n \"tax_number\": \"433112356002000\",\n \"point_cutoff_period\": \"31-12\",\n \"point_converter\": 50000,\n \"cogs_method\": \"AVERAGE\",\n \"margin\": 0.04,\n \"non_member\": 0.03,\n \"branch_code\": \"TCHO004\",\n \"branch_type\": \"DISTRIBUTOR\",\n \"created_at\": \"2023-05-31T09:27:58.512Z\",\n \"updated_at\": \"2023-05-31T09:27:58.512Z\"\n },\n \"fe_url\": \"https://pangan-dev.flexy.id\"\n }\n}"}],"_postman_id":"8039e578-b12a-49ce-9207-4e6a380e9749"},{"name":"Get Info","id":"3f81f5bd-fe4a-4c80-a917-f062cd3b81da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reference_id\": \"pinjammodal25\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/openapi/v1/clients/info","description":"