# Get started This page takes you from an empty developer console to a first authenticated API call. You register an app, install it on a store you own, exchange the code for an install token and call `GET /v1/whoami`. ## Before you start[​](#before-you-start "Direct link to Before you start") * A DZBuild account that owns at least one store. A test install only works on a store your account owns, not on a store where you are a team member. * A redirect URI on `https` that your app controls. The console refuses `http`. The quickest option is a Worker on `workers.dev` from [/apps/new](https://dzbuild.dev/apps/new), registered once; an https tunnel to your machine also works, but its address changes on each run and the console holds at most 5 redirect URIs. * `curl` and `openssl` on your machine. ## Start from the example app[​](#start-from-the-example-app "Direct link to Start from the example app") The fastest start is [/apps/new](https://dzbuild.dev/apps/new): pick one of three Cloudflare presets, deploy it to a free `workers.dev` address and get the exact values for the console. * `cloudflare-basic`: the install flow, one token per store and the launch link. The base for your own app. * `cloudflare-catalog`: a products page for the merchant and a CSV export of the catalog. * `cloudflare-orders`: new-order alerts to Telegram by polling `GET /v1/orders` once a minute; order webhooks once you own a domain. Scaffold the basic preset in one command, or deploy it from the browser with the button below. Cloudflare clones it into your GitHub account and deploys it; the preset README lists the steps that follow. ``` npm create cloudflare@latest my-app -- --template DZBuild-com/dzbuild-app-starter/cloudflare-basic --no-agents --no-git --no-deploy --no-open ``` [![Deploy to Cloudflare](data:image/svg+xml;base64,<svg width="184" height="39" viewBox="0 0 184 39" fill="none" xmlns="http://www.w3.org/2000/svg">
  <path
    d="M1 4C1 2.34315 2.34315 1 4 1H180C181.657 1 183 2.34315 183 4V35C183 36.6569 181.657 38 180 38H4C2.34314 38 1 36.6569 1 35V4Z"
    fill="black" />
  <path
    d="M1 4C1 2.34315 2.34315 1 4 1H180C181.657 1 183 2.34315 183 4V35C183 36.6569 181.657 38 180 38H4C2.34314 38 1 36.6569 1 35V4Z"
    stroke="#F6821F" stroke-width="2" />
  <path
    d="M28.8868 24.7745L29.0095 24.35C29.1558 23.8449 29.1014 23.378 28.8559 23.0349C28.6302 22.7189 28.2539 22.5328 27.797 22.5112L19.1416 22.4009C19.0833 22.3978 19.0351 22.3715 19.0054 22.3283C18.9753 22.2839 18.9683 22.2268 18.9869 22.172C19.0154 22.0867 19.0999 22.0223 19.1879 22.0184L27.9236 21.9077C28.9597 21.8602 30.0816 21.0194 30.4745 19.994L30.9727 18.6924C30.9864 18.657 30.9926 18.6194 30.9923 18.5817C30.9922 18.5612 30.9907 18.5406 30.9862 18.5203C30.4201 15.9761 28.1497 14.0736 25.4348 14.0736C22.9333 14.0736 20.8092 15.6882 20.0474 17.9322C19.5557 17.5633 18.9267 17.3672 18.2506 17.4348C17.0504 17.554 16.086 18.5203 15.9667 19.7204C15.9354 20.0319 15.9609 20.3325 16.0327 20.615C14.0722 20.6721 12.5 22.2782 12.5 24.2524C12.5 24.4311 12.5135 24.6067 12.5386 24.7784C12.5509 24.8618 12.6212 24.9243 12.7053 24.9243L28.6846 24.9262C28.6862 24.9262 28.6876 24.9255 28.6892 24.9254C28.7806 24.9234 28.861 24.8629 28.8868 24.7745Z"
    fill="url(#paint0_linear_261_5859)" />
  <path
    d="M31.7695 18.7879C31.6892 18.7879 31.6093 18.7902 31.5298 18.7941C31.5167 18.7948 31.5042 18.798 31.4923 18.8022C31.4508 18.8167 31.4177 18.8503 31.4051 18.8941L31.0648 20.0695C30.9185 20.5746 30.9729 21.0412 31.2184 21.3842C31.4441 21.7007 31.8204 21.8863 32.2773 21.9079L34.1224 22.0187C34.1768 22.0213 34.2247 22.0476 34.254 22.09C34.2848 22.1348 34.2918 22.1923 34.2733 22.2471C34.2443 22.3324 34.1602 22.3968 34.0726 22.4007L32.1553 22.5114C31.1145 22.5593 29.9927 23.3998 29.5998 24.4251L29.4612 24.7871C29.436 24.8526 29.483 24.9223 29.5522 24.9258C29.554 24.9258 29.5556 24.9264 29.5573 24.9264H36.1542C36.233 24.9264 36.3032 24.8751 36.3244 24.7994C36.439 24.3919 36.5 23.9624 36.5 23.5183C36.5 20.9057 34.3821 18.7879 31.7695 18.7879Z"
    fill="url(#paint1_linear_261_5859)" />
  <path
    d="M46.0801 24.5V14.6357H49.6826C52.6221 14.6357 54.3721 16.4131 54.3721 19.5303V19.5439C54.3721 22.668 52.6357 24.5 49.6826 24.5H46.0801ZM47.8438 23.0098H49.498C51.4805 23.0098 52.5742 21.7998 52.5742 19.5508V19.5371C52.5742 17.3359 51.46 16.126 49.498 16.126H47.8438V23.0098ZM58.7881 24.6436C56.6143 24.6436 55.3018 23.2012 55.3018 20.8975V20.8906C55.3018 18.6074 56.6348 17.1035 58.7061 17.1035C60.7773 17.1035 62.0625 18.5596 62.0625 20.7471V21.2939H56.9902C57.0176 22.5654 57.7148 23.3174 58.8223 23.3174C59.6699 23.3174 60.2236 22.8662 60.3877 22.3809L60.4014 22.333H61.9941L61.9736 22.4082C61.748 23.5225 60.6816 24.6436 58.7881 24.6436ZM58.7266 18.4365C57.8242 18.4365 57.1475 19.0449 57.0107 20.1592H60.4082C60.2852 19.0107 59.6289 18.4365 58.7266 18.4365ZM63.1631 26.8926V17.2539H64.8652V18.5049H64.8994C65.3164 17.6367 66.1094 17.1035 67.1484 17.1035C68.9873 17.1035 70.1494 18.5391 70.1494 20.877V20.8838C70.1494 23.208 68.9873 24.6436 67.1689 24.6436C66.1367 24.6436 65.3096 24.124 64.8994 23.2764H64.8652V26.8926H63.1631ZM66.6426 23.208C67.7295 23.208 68.4131 22.3125 68.4131 20.8838V20.877C68.4131 19.4277 67.7295 18.5391 66.6426 18.5391C65.5898 18.5391 64.8516 19.4551 64.8516 20.877V20.8838C64.8516 22.2988 65.5898 23.208 66.6426 23.208ZM71.291 24.5V14.6357H72.9932V24.5H71.291ZM77.6484 24.6436C75.5156 24.6436 74.1416 23.2217 74.1416 20.877V20.8633C74.1416 18.5391 75.5361 17.1035 77.6416 17.1035C79.7539 17.1035 81.1553 18.5254 81.1553 20.8633V20.877C81.1553 23.2285 79.7744 24.6436 77.6484 24.6436ZM77.6553 23.2695C78.7285 23.2695 79.4189 22.3945 79.4189 20.877V20.8633C79.4189 19.3525 78.7217 18.4844 77.6416 18.4844C76.582 18.4844 75.8779 19.3594 75.8779 20.8633V20.877C75.8779 22.4014 76.5684 23.2695 77.6553 23.2695ZM82.96 26.9062C82.6318 26.9062 82.29 26.8652 82.085 26.8311V25.5322C82.2148 25.5596 82.4131 25.5938 82.6523 25.5938C83.3018 25.5938 83.6641 25.4092 83.8828 24.8008L83.9854 24.5068L81.3809 17.2539H83.2402L84.9355 23.0508H84.9834L86.6855 17.2539H88.4766L85.8721 24.7461C85.3184 26.3389 84.4707 26.9062 82.96 26.9062ZM94.7588 24.6436C93.2412 24.6436 92.5234 24.0283 92.5234 22.5381V18.5664H91.498V17.2539H92.5234V15.415H94.2529V17.2539H95.5996V18.5664H94.2529V22.3945C94.2529 23.1055 94.5674 23.3311 95.1895 23.3311C95.3535 23.3311 95.4834 23.3105 95.5996 23.3037V24.582C95.4014 24.6094 95.1006 24.6436 94.7588 24.6436ZM99.8379 24.6436C97.7051 24.6436 96.3311 23.2217 96.3311 20.877V20.8633C96.3311 18.5391 97.7256 17.1035 99.8311 17.1035C101.943 17.1035 103.345 18.5254 103.345 20.8633V20.877C103.345 23.2285 101.964 24.6436 99.8379 24.6436ZM99.8447 23.2695C100.918 23.2695 101.608 22.3945 101.608 20.877V20.8633C101.608 19.3525 100.911 18.4844 99.8311 18.4844C98.7715 18.4844 98.0674 19.3594 98.0674 20.8633V20.877C98.0674 22.4014 98.7578 23.2695 99.8447 23.2695ZM111.705 24.6709C108.868 24.6709 107.077 22.7158 107.077 19.5645V19.5576C107.077 16.4062 108.875 14.4648 111.705 14.4648C113.975 14.4648 115.643 15.8799 115.902 17.8896L115.909 17.958H114.18L114.146 17.8281C113.858 16.7002 112.99 15.9961 111.705 15.9961C109.982 15.9961 108.882 17.3701 108.882 19.5576V19.5645C108.882 21.7588 109.989 23.1396 111.705 23.1396C112.963 23.1396 113.845 22.4629 114.166 21.2461L114.187 21.1777H115.916L115.902 21.2461C115.649 23.2695 113.975 24.6709 111.705 24.6709ZM117.133 24.5V14.6357H118.835V24.5H117.133ZM123.49 24.6436C121.357 24.6436 119.983 23.2217 119.983 20.877V20.8633C119.983 18.5391 121.378 17.1035 123.483 17.1035C125.596 17.1035 126.997 18.5254 126.997 20.8633V20.877C126.997 23.2285 125.616 24.6436 123.49 24.6436ZM123.497 23.2695C124.57 23.2695 125.261 22.3945 125.261 20.877V20.8633C125.261 19.3525 124.563 18.4844 123.483 18.4844C122.424 18.4844 121.72 19.3594 121.72 20.8633V20.877C121.72 22.4014 122.41 23.2695 123.497 23.2695ZM130.559 24.6436C128.966 24.6436 128.057 23.6182 128.057 21.9365V17.2539H129.759V21.6016C129.759 22.627 130.237 23.208 131.208 23.208C132.186 23.208 132.808 22.5039 132.808 21.4512V17.2539H134.51V24.5H132.808V23.3652H132.773C132.397 24.1377 131.652 24.6436 130.559 24.6436ZM138.604 24.6436C136.772 24.6436 135.61 23.208 135.61 20.877V20.8701C135.61 18.5322 136.779 17.1035 138.598 17.1035C139.623 17.1035 140.45 17.6299 140.86 18.498H140.901V14.6357H142.604V24.5H140.901V23.2695H140.86C140.45 24.124 139.65 24.6436 138.604 24.6436ZM139.117 23.208C140.17 23.208 140.901 22.2988 140.901 20.877V20.8701C140.901 19.4551 140.163 18.5391 139.117 18.5391C138.03 18.5391 137.347 19.4277 137.347 20.8701V20.877C137.347 22.3193 138.023 23.208 139.117 23.208ZM144.504 24.5V18.5664H143.513V17.2539H144.504V16.5635C144.504 15.1484 145.174 14.4922 146.746 14.4922C147.081 14.4922 147.443 14.5195 147.655 14.5605V15.75C147.519 15.7295 147.327 15.7158 147.143 15.7158C146.479 15.7158 146.172 16.0234 146.172 16.6113V17.2539H147.628V18.5664H146.206V24.5H144.504ZM148.797 24.5V14.6357H150.499V24.5H148.797ZM154.088 24.623C152.639 24.623 151.661 23.7275 151.661 22.4355V22.4219C151.661 21.1367 152.659 20.3643 154.416 20.2549L156.31 20.1387V19.6396C156.31 18.9082 155.831 18.4639 154.97 18.4639C154.163 18.4639 153.671 18.8398 153.562 19.373L153.548 19.4346H151.969L151.976 19.3525C152.078 18.0674 153.192 17.1035 155.031 17.1035C156.843 17.1035 158.012 18.0605 158.012 19.5166V24.5H156.31V23.3857H156.269C155.852 24.1445 155.045 24.623 154.088 24.623ZM153.356 22.3672C153.356 22.9619 153.849 23.3242 154.594 23.3242C155.571 23.3242 156.31 22.6748 156.31 21.8135V21.2666L154.655 21.3691C153.814 21.4238 153.356 21.7861 153.356 22.3604V22.3672ZM159.386 24.5V17.2539H161.04V18.4639H161.074C161.293 17.6162 161.929 17.1035 162.783 17.1035C162.995 17.1035 163.193 17.1377 163.323 17.1719V18.71C163.18 18.6553 162.92 18.6143 162.633 18.6143C161.669 18.6143 161.088 19.2363 161.088 20.2549V24.5H159.386ZM167.11 24.6436C164.937 24.6436 163.624 23.2012 163.624 20.8975V20.8906C163.624 18.6074 164.957 17.1035 167.028 17.1035C169.1 17.1035 170.385 18.5596 170.385 20.7471V21.2939H165.312C165.34 22.5654 166.037 23.3174 167.145 23.3174C167.992 23.3174 168.546 22.8662 168.71 22.3809L168.724 22.333H170.316L170.296 22.4082C170.07 23.5225 169.004 24.6436 167.11 24.6436ZM167.049 18.4365C166.146 18.4365 165.47 19.0449 165.333 20.1592H168.73C168.607 19.0107 167.951 18.4365 167.049 18.4365Z"
    fill="url(#paint2_linear_261_5859)" />
  <defs>
    <linearGradient id="paint0_linear_261_5859" x1="14.292" y1="12.9108" x2="13.2175" y2="23.4488"
      gradientUnits="userSpaceOnUse">
      <stop stop-color="#FBAD41" />
      <stop offset="1" stop-color="#FF6633" />
    </linearGradient>
    <linearGradient id="paint1_linear_261_5859" x1="30.1371" y1="18.1302" x2="29.2458" y2="24.0178"
      gradientUnits="userSpaceOnUse">
      <stop stop-color="#FBAD41" />
      <stop offset="1" stop-color="#FF6633" />
    </linearGradient>
    <linearGradient id="paint2_linear_261_5859" x1="44.5303" y1="25.3333" x2="139.907" y2="78.0713"
      gradientUnits="userSpaceOnUse">
      <stop stop-color="#FBAD41" />
      <stop offset="1" stop-color="#FF6633" />
    </linearGradient>
  </defs>
</svg>)](https://deploy.workers.cloudflare.com/?url=https://github.com/DZBuild-com/dzbuild-app-starter/tree/main/cloudflare-basic) If you host on your own server instead, the Node.js example in the same [repository](https://github.com/DZBuild-com/dzbuild-app-starter) has the same flow with no dependencies and offline tests. Fill in the environment variables in `.env.example` from your console. ## 1. Register the app[​](#1-register-the-app "Direct link to 1. Register the app") Open the developer console at `https://dzbuild.com/dashboard/developer` and choose **New app** (`/dashboard/developer/apps/new`). Fill in the form: | Field | What to enter | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Name | The app name merchants see on the consent screen. | | Developer name | Your name or your company's name, shown on the consent screen. | | Descriptions | One description each in English, Arabic and French. | | Homepage | Your app's website, `https` only. The **Install** button on the merchant's Extensions page opens this address, or the launch URL when it is empty, so it must lead to your install flow. | | Support email | The address merchants write to for help. | | Launch URL | The `https` page that opens when a merchant clicks **Open** on your app. | | Redirect URIs | One to five exact URIs. DZBuild sends the authorization code only to these. | | Scopes | The permissions your app may request. See [Scopes](https://dzbuild.dev/scopes.md). | | Minimum plan | The lowest store plan that may use your app. Leave it on Free to allow every store. | | Webhook URL and events | Optional. See [Webhooks](https://dzbuild.dev/webhooks.md). | Save the app. The console then shows three credentials: | Credential | Format | Where it lives | | -------------- | -------------------------------------- | -------------------------------------------------------------------------------------- | | `client_id` | `dzapp_` followed by 20 hex characters | Public. It goes in the authorize URL. | | Client secret | `dzas_` followed by 48 hex characters | Shown once. Store it on your server. Generate a new one in the console if you lose it. | | Signing secret | 64 hex characters | Viewable in the console. It signs webhooks and launch tokens. | The new app is a draft. A draft runs only on stores your own account owns, which is what you need for testing. ## 2. Choose scopes[​](#2-choose-scopes "Direct link to 2. Choose scopes") Register only the scopes your app uses. On the consent screen, the merchant sees one line per resource you request. At install time you can ask for fewer scopes than you registered with the `scope` parameter, but never more. The full list is on the [Scopes](https://dzbuild.dev/scopes.md) page. ## 3. Set your redirect URIs[​](#3-set-your-redirect-uris "Direct link to 3. Set your redirect URIs") DZBuild compares the `redirect_uri` you send with your registered URIs as exact strings. A trailing slash, a different letter case or an extra query parameter makes it a different URI. A URI with a fragment (`#`) is refused when you save the app. If the `redirect_uri` does not match, DZBuild shows an error page and does not redirect at all. ## 4. Install the app on your own store[​](#4-install-the-app-on-your-own-store "Direct link to 4. Install the app on your own store") Create a PKCE verifier and its `S256` challenge. The verifier stays on your server. ``` CODE_VERIFIER=$(openssl rand -hex 32) CODE_CHALLENGE=$(printf %s "$CODE_VERIFIER" | openssl dgst -sha256 -binary | openssl base64 -A | tr '+/' '-_' | tr -d '=') STATE=$(openssl rand -hex 16) ``` Send your browser to the authorize URL. Encode each value; spaces between scopes become `%20`. ``` GET https://dzbuild.com/oauth/apps/authorize?response_type=code&client_id=dzapp_0123456789abcdef0123&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&scope=store%3Aread%20orders%3Aread&state=STATE&code_challenge=CODE_CHALLENGE&code_challenge_method=S256 ``` Log in to DZBuild if asked. The consent screen lists your stores and marks the ones that cannot install the app. Pick a store and approve. DZBuild redirects to your URI: ``` HTTP/1.1 302 Found Location: https://app.example.com/callback?code=CODE&state=STATE ``` Check that `state` is the value you sent. The code is valid for 10 minutes and works once. Exchange the code for an install token. Send the form from your server, never from a browser. ``` curl -s https://dzbuild.com/oauth/apps/token \ -d grant_type=authorization_code \ -d code="$CODE" \ --data-urlencode redirect_uri=https://app.example.com/callback \ -d code_verifier="$CODE_VERIFIER" \ -d client_id="$DZ_CLIENT_ID" \ -d client_secret="$DZ_CLIENT_SECRET" ``` A successful answer looks like this: ``` { "access_token": "dzpk_live_0a1b2c3d4e5f67.9f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c5b4a3928", "token_type": "Bearer", "scope": "store:read orders:read", "store_id": 141, "install_id": 7, "stores": [ { "store_id": 141, "store_name": "My test store", "install_id": 7, "access_token": "dzpk_live_0a1b2c3d4e5f67.9f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c5b4a3928" } ] } ``` Save each `access_token` with its `store_id` and `install_id`. There is no `expires_in` and no refresh token: the token works until the merchant uninstalls your app. The [OAuth](https://dzbuild.dev/oauth.md) page lists every error this call can return. ## 5. Make your first call[​](#5-make-your-first-call "Direct link to 5. Make your first call") Call `GET /v1/whoami` with the install token. It needs no scope, so it works for every install. ``` curl -s https://api.dzbuild.app/v1/whoami \ -H "Authorization: Bearer $DZ_TOKEN" ``` ``` { "data": { "key_id": "dzpk_live_0a1b2c3d4e5f67", "store_id": 141, "type": "platform", "rate_limit_tier": "enterprise", "pilot": true, "scopes": ["store:read", "orders:read"], "app": { "app_id": 3, "client_id": "dzapp_0123456789abcdef0123", "install_id": 7 } }, "meta": { "request_id": "5f2c9a0b1d3e4f60", "api_version": "v1" } } ``` ## 6. Read the app object[​](#6-read-the-app-object "Direct link to 6. Read the app object") The `app` object appears only when the token belongs to an app install. It tells your server which app and which install made the call. | Field | Meaning | | ------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `app_id` | Your app's numeric id on DZBuild. | | `client_id` | Your app's public client id. Compare it with your own to reject tokens issued to another app. | | `install_id` | The install this token belongs to. It stays the same if the merchant uninstalls and installs your app again on the same store. | `rate_limit_tier` is `enterprise` for every install token, whatever plan the store is on. Your real budget is the per-install limit described in [Core concepts](https://dzbuild.dev/concepts.md). ## Next steps[​](#next-steps "Direct link to Next steps") * Read [Core concepts](https://dzbuild.dev/concepts.md) before you build on install tokens. * Add [webhook verification](https://dzbuild.dev/webhooks.md) if you registered a webhook URL. * Read the [review guidelines](https://dzbuild.dev/review-guidelines.md), then submit the app for review from the console.