Ryde Developers
Español Dashboard ryde.us.com

Your first Ryde integration

From a developer account to a working sandbox call, in ten steps.

API version v1 · View as Markdown

COMING SOON — developer signup is not open yet. The flow below is the one being built, published now so you can see what integrating will involve and raise anything that would not work for you.

  1. Create a developer accountSign in with the same phone-first Ryde identity customers use. A developer account is a Ryde account with developer access, not a separate login to remember.
  2. Create or join an organizationApplications belong to an organization, never to a person. That is deliberate: people change jobs and credentials should not leave with them.
  3. Accept the Developer AgreementSigned once per organization, e-signed and versioned. It is separate from a customer's Ryde One membership and from a merchant's Business Agreement — three different relationships.
  4. Register an applicationName, logo, website, privacy policy, redirect URIs and the scopes you are requesting. Ask for the fewest scopes that make your product work.
  5. Receive sandbox credentialsIssued immediately. Sandbox never dispatches a real driver, never charges a real card and never reaches a real merchant.
  6. Implement OAuthAuthorization code with PKCE. The customer signs in on Ryde and approves your scopes on a Ryde-hosted screen; you never see their credentials.
  7. Make your first readSearch merchants or quote a fare. Reads and quotes need no membership, so they work for every connected customer from the start.
  8. Test the Ryde One boundaryTry to transact as a customer with no membership and handle the 403 RYDE_ONE_REQUIRED properly. This is the single most common integration bug, and the sandbox lets you reproduce it on demand.
  9. Test failures and cancellationsNo driver found, a merchant rejecting an order, a customer cancelling. An agent that only handles the happy path is not finished.
  10. Request production accessSandbox is automatic; production is reviewed, because these APIs move real vehicles, real food and real people's money.