Connect your own API

Your app talks to one API, described in the Yallapp API contract (OpenAPI 3.1). On WordPress the Yallapp plugin serves it. If your website runs on something else, your developer can serve the same endpoints, and the app works with them unchanged.

1. 1

   Read the contract

   Download openapi.yaml and open it in any OpenAPI viewer. Every path, field and error code the app uses is there. JSON everywhere, dates in ISO 8601 UTC, errors as { code, message } with a stable code, lists paged with page and per_page.

2. 2

   Start with what every app needs

   GET /config, the sign-in endpoints (/auth/otp/request, /auth/otp/verify, /auth/register, /auth/refresh, /auth/logout), and the account endpoints under /me. Signed-in calls send Authorization: Bearer <access_token>; you send the one-time code by SMS or WhatsApp from your own system.

3. 3

   Add your app type's endpoints

   Academy apps use the Catalog, Learning and Quizzes endpoints, starting with GET /home. Store apps use the Store endpoints, starting with GET /store/home, and need store in /config. Bookings apps use the Bookings endpoints, starting with GET /bookings/home, and need bookings in /config. Features you don't support can be turned off in /config, and the app hides them.

4. 4

   Check it from your dashboard

   On the Website step, choose My own API, enter its address and select Run the check. We call it the way the app does and list anything missing. When the check passes, save the step and continue the setup.

   infoYour API must be reachable on the public internet over https. Private and local addresses are refused.

Your next build talks to your API. If you change the address later, the next build uses the new one.