Using the developer dashboard

Get set up

The three screens every integration starts from, whichever path you take.

• Create your account
  Sign up with a mobile number and get a sandbox key in about a minute.
  3 min
• Generate an API key
  Issue, reveal, rotate and revoke keys — and what happens to the old one.
  4 min
• Choose your capabilities
  Decide what your keys are allowed to call, and fix a 403 API_NOT_ALLOWED.
  4 min

Hosted embed

For the hosted checkout, where OroPocket renders the whole buy and sell flow.

• Test a hosted embed
  Issue a user_code and drive the real embed in the Playground's phone preview.
  5 min
• See users and transactions
  Find a customer by user_code and read their trades across every channel.
  4 min

Raw API

For a server-to-server integration where you build the interface yourself.

• Make your first API call
  Fire a real request from the dashboard and copy it out as curl.
  4 min
• Run a test buy
  Register a user, quote a buy, confirm it, and check the portfolio.
  6 min
• Debug with request logs
  Find the call that failed, read its error code, and quote a request id.
  4 min
• Set up webhooks
  Register an endpoint, send a test event, and replay a failed delivery.
  6 min

Whitelabel

For running OroPocket on your own domain, under your own brand.

• Connect your domain
  Point a subdomain at us with a CNAME and pass the DNS check.
  5 min
• Add your brand
  Upload a wordmark, a logo and the square app icon your users install.
  4 min
• Edit your sign-in page
  Write the heading, sub-heading and trust line your customers read first.
  4 min
• Submit for review
  What review checks, and why approved is not the same as live.
  4 min

Money

What you earn, what you owe, and the spread you can charge on top.

• Set your merchant markup
  Charge your own spread on our rate, on both the buy and the sell side.
  5 min
• Top up your billing account
  Keep the account your API buys are charged to from running dry.
  5 min

Common questions

Do I need to be approved before I can follow these tutorials?

No. Everything in the Get set up, Hosted embed and Raw API sections works in Test mode with a sandbox key, which you get the moment you sign up. Test mode uses live gold and silver prices but simulates settlement, so no real money moves. Production access is a separate, free application.

Where do I find my API key in the dashboard?

Under API keys in the Build section of the sidebar. There is one key per mode — one Test key and one Live key. A key is shown in full exactly once, when it is issued; afterwards the dashboard only shows the last four characters.

Why does my API call return 403 API_NOT_ALLOWED?

Your key does not carry the capability that endpoint requires. Capabilities are set on the Capabilities page in the dashboard, where you pick what you are building and we enable exactly the APIs it needs. Turning a capability off takes effect immediately.

Can I test the hosted embed without building an app first?

Yes. The Playground has an Embed tab that issues a user_code and loads the real hosted checkout in a phone-sized preview inside the dashboard, so you can drive the whole flow before you write any WebView code. In Test mode the embed OTP is always 1234.

What is the difference between these tutorials and the API docs?

The docs describe the API — endpoints, parameters, payloads. These tutorials describe the dashboard: the screens you click through to get a key, test a call, read your logs, configure a white-label domain and see what you have earned.