Skip to content
aaxo.nz

Help · Apps & developers

API quick start

Create a secret key, make your first request, and subscribe to webhooks.

5 min · 5 steps

  1. 1

    Create a secret key

    Open Apps & API, choose Secret key — server, name it and click Create key. Keep it on your server only.

  2. 2

    Check the key

    Run: curl https://axo.nz/api/public/v1/me -H "Authorization: Bearer YOUR_SECRET_KEY". It returns your plan and rate limit.

  3. 3

    Create a link from code

    POST https://axo.nz/api/public/v1/links with a JSON body such as {"destination":"https://example.com/page"}. See the developer guide for all fields.

  4. 4

    Subscribe to webhooks

    In Apps & API, enter your HTTPS address under Webhooks, choose events and click Add webhook. Save the signing secret and verify each delivery's AXO-Signature header.

  5. 5

    Send a test

    Click Send test to check your server receives and verifies the delivery.

Good to know

  • The API is included with Business and Enterprise. Rate limits per key: 300 requests a minute on Business, 1,200 on Enterprise.