Provider Developer Onboarding

This is still a work in progress and for the short term will be a manual process

  1. Contact us directly at [api-support (at) powerepos.cloud] to setup your developer credentials
    • We will need your company name, website and primary contact details
    • optionally We will need a URI for a webhook where we can communicate events back to you via HTTP. See Notifications Webhook
    • We will send you the following details:
      • ProviderID - int - Unique number to identify your organisation
      • ClientID - string - OAuth2 Client ID (public information)
      • ClientSecret - string - OAuth2 Client Secret (sensitive information)
      • WebhookSecret - string - The secret for signing web requests being sent your webhook (Sensitive information)
    • For development purposes we will also generate a test organisation with two outlets that you can use for testing. This test organisation will come with a web based sandbox UI where you can emulate the role of a POS.
  2. Have an outlet configure a ROS connection to your provider ID:
    • They will do this in their PSM tool for configuring their POS.
    • They will be able to provide you with the following from the configuration process:
      • Organisation Code - string - a unique identifier for their organisation
      • OutletID - Guid - an identifier for the outlet within the Organisation.
      • IMPORTANT: OutletID is only unique within the Organisation, other Organisations may also have the same OutletID due to templating. As such your must always pair both the Organisation Code and OutletID together to uniquely identify an outlet globally.
  3. Generate an Access Token
  4. Start interacting with the various HTTP Endpoints
  5. When the integration is approaching beta ready, please contact us and organise a compliance test

Development Sandbox

You will be granted access to a sandbox development testing environment that will simulate the behaviour of a real PowerEPOS Terminal. You can use this build your integration and validate your webhook interface.

It will allow you to see the contents of orders as you send them and to control whether they should be confirmed/rejected. It will also allow you to simulate changing menus and other notifications.

Troubleshooting

We have a dedicated troubleshooting page but if you need to ask a question please email us at [api-support (at) powerepos.cloud]