{ "opencollection": "1.0.0", "info": { "name": "Flipdish API - Apps Accounts Hydra API", "version": "v1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Hydra", "type": "folder" }, "items": [ { "info": { "name": "Flipdish Get Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/hydra/settings", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Settings via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/settings)." }, { "info": { "name": "Flipdish Get Ably Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/hydra/ably_token", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Ably Token via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/ably_token)." }, { "info": { "name": "Flipdish Get Registration", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/hydra/registration", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Registration via the Flipdish Open API v1.0 (GET /api/v1.0/hydra/registration)." }, { "info": { "name": "Flipdish Hydra_Get Emvs for App Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/emvterminals", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Hydra_Get Emvs for App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/emvterminals)." }, { "info": { "name": "Flipdish Hydra_Create Emv", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/emvterminals", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Hydra_Create Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/emvterminals)." }, { "info": { "name": "Flipdish Get EMV Terminal Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/emvterminal", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get EMV Terminal Details via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/emvterminal)." }, { "info": { "name": "Flipdish Get Kiosk Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/kiosksettings/:deviceId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Kiosk Settings via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/kiosksettings/{deviceId})." }, { "info": { "name": "Flipdish Update Kiosk Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/kiosksettings/:deviceId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update Kiosk Settings via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/kiosksettings/{deviceId})." }, { "info": { "name": "Flipdish Get Kiosk Cash Payment Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/kioskcashsettings/:deviceId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Kiosk Cash Payment Settings via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/kioskcashsettings/{deviceId})." }, { "info": { "name": "Flipdish Get Emv Order State", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/emvorderstate/:orderId", "params": [ { "name": "orderId", "value": "500123", "type": "path", "description": "The order id path parameter." }, { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Emv Order State via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/emvorderstate/{orderId})." }, { "info": { "name": "Flipdish Get Attached Device", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/:deviceType/:deviceId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceType", "value": "Kiosk", "type": "path", "description": "The device type path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Attached Device via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/{deviceType}/{deviceId})." }, { "info": { "name": "Flipdish Get Attached Devices", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/:deviceType/list", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceType", "value": "Kiosk", "type": "path", "description": "The device type path parameter." }, { "name": "pageIndex", "value": "1", "type": "query", "description": "The page index query parameter." }, { "name": "pageSize", "value": "1", "type": "query", "description": "The page size query parameter." }, { "name": "storeId", "value": "500123", "type": "query", "description": "The store id query parameter." }, { "name": "deviceName", "value": "Example Name", "type": "query", "description": "The device name query parameter." }, { "name": "deviceSerial", "value": "string", "type": "query", "description": "The device serial query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Attached Devices via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/hydra/{deviceType}/list)." }, { "info": { "name": "Flipdish Register", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/registration", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Register via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/registration)." }, { "info": { "name": "Flipdish Cancel Emv Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/cancelemvpayment/:orderId", "params": [ { "name": "orderId", "value": "500123", "type": "path", "description": "The order id path parameter." }, { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancel Emv Payment via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/cancelemvpayment/{orderId})." }, { "info": { "name": "Flipdish Attach Store to Terminal", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/:deviceId/attach/:storeId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "storeId", "value": "500123", "type": "path", "description": "The store id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Attach Store to Terminal via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/{deviceId}/attach/{storeId})." }, { "info": { "name": "Flipdish Detach Store from Terminal", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/:deviceId/detach/:storeId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "storeId", "value": "500123", "type": "path", "description": "The store id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Detach Store from Terminal via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/{deviceId}/detach/{storeId})." }, { "info": { "name": "Flipdish Unassign Emv", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/emvterminal/unassign/:hydraConfigId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "hydraConfigId", "value": "500123", "type": "path", "description": "The hydra config id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unassign Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/emvterminal/unassign/{hydraConfigId})." }, { "info": { "name": "Flipdish Attach Store to Kiosk", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/AttachStoreToKiosk/:deviceId/store/:storeId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "storeId", "value": "500123", "type": "path", "description": "The store id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Attach Store to Kiosk via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/AttachStoreToKiosk/{deviceId}/store/{storeId})." }, { "info": { "name": "Flipdish Assign Emv", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/emvterminal/assign/:hydraConfigId/:emvTerminalId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "hydraConfigId", "value": "500123", "type": "path", "description": "The hydra config id path parameter." }, { "name": "emvTerminalId", "value": "500123", "type": "path", "description": "The emv terminal id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Assign Emv via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/hydra/emvterminal/assign/{hydraConfigId}/{emvTerminalId})." }, { "info": { "name": "Flipdish Login with Device Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/hydra/:deviceId/login", "params": [ { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." }, { "name": "hydraUserType", "value": "Kiosk", "type": "query", "description": "The hydra user type query parameter." }, { "name": "serialNumber", "value": "string", "type": "query", "description": "The serial number query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Login with Device Id via the Flipdish Open API v1.0 (POST /api/v1.0/hydra/{deviceId}/login)." }, { "info": { "name": "Flipdish Update Kiosk Cash Visibility Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/kioskupdatecashsettings", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "query", "description": "The device id query parameter." }, { "name": "isCashEnabled", "value": "true", "type": "query", "description": "The is cash enabled query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update Kiosk Cash Visibility Settings via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/kioskupdatecashsettings)." }, { "info": { "name": "Flipdish Hydra_Delete Emv", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/:appId/emvterminals/:id", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "id", "value": "500123", "type": "path", "description": "The id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Hydra_Delete Emv via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/emvterminals/{id})." }, { "info": { "name": "Flipdish Un Assign", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/:appId/hydra/:deviceId/registration", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Un Assign via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/hydra/{deviceId}/registration)." }, { "info": { "name": "Flipdish Hydra_Detach Store from Kiosk", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/:appId/DetachStoreFromKiosk/:deviceId/store/:storeId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "storeId", "value": "500123", "type": "path", "description": "The store id path parameter." }, { "name": "deviceId", "value": "500123", "type": "path", "description": "The device id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Hydra_Detach Store from Kiosk via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/DetachStoreFromKiosk/{deviceId}/store/{storeId})." } ] } ], "bundled": true }