API REST

API REST fiel ao código.

Base URL: https://api.aifoxapp.com/api/v1

Autenticação

Use um token JWT Bearer ou uma API key onde indicado.

Exemplo JWT

Authorization: Bearer $AIFOX_TOKEN

Exemplo API key

X-API-Key: $AIFOX_API_KEY

Auth

POST/auth/register

Cria um usuário e sua organização.

URL completa: https://api.aifoxapp.com/api/v1/auth/register
Acesso: Público
Entradas: email, password, full_name?, org_name?, terms_accepted
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/auth/register' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/auth/login

Retorna um token de acesso Bearer.

URL completa: https://api.aifoxapp.com/api/v1/auth/login
Acesso: Público
Entradas: application/x-www-form-urlencoded: username, password
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/auth/login' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/auth/me

Retorna o usuário atual.

URL completa: https://api.aifoxapp.com/api/v1/auth/me
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/auth/me' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/auth/org

Retorna a organização atual.

URL completa: https://api.aifoxapp.com/api/v1/auth/org
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/auth/org' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Apps

GET/apps/

Lista ou cria os apps da organização.

URL completa: https://api.aifoxapp.com/api/v1/apps/
Acesso: JWT ou API key
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/apps/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/apps/

Lista ou cria os apps da organização.

URL completa: https://api.aifoxapp.com/api/v1/apps/
Acesso: JWT ou API key
Entradas: name, package_name, platform=both, min_native_version?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/apps/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/apps/{app_id}

Consulta, atualiza ou remove um app.

URL completa: https://api.aifoxapp.com/api/v1/apps/{app_id}
Acesso: JWT ou API key
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/apps/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

PUT/apps/{app_id}

Consulta, atualiza ou remove um app.

URL completa: https://api.aifoxapp.com/api/v1/apps/{app_id}
Acesso: JWT ou API key
Entradas: app_id; name?, min_native_version?, icon_url?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X PUT 'https://api.aifoxapp.com/api/v1/apps/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

DELETE/apps/{app_id}

Consulta, atualiza ou remove um app.

URL completa: https://api.aifoxapp.com/api/v1/apps/{app_id}
Acesso: JWT ou API key
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/apps/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Bundles

GET/bundles/app/{app_id}

Lista bundles OTA ativos do app.

URL completa: https://api.aifoxapp.com/api/v1/bundles/app/{app_id}
Acesso: JWT ou API key
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/bundles/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/bundles/app/{app_id}/upload

Envia e valida um bundle ZIP.

URL completa: https://api.aifoxapp.com/api/v1/bundles/app/{app_id}/upload
Acesso: JWT ou API key
Entradas: multipart: version, file (.zip, max 200 MB)
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/bundles/app/{app_id}/upload' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -F 'version=1.0.0' -F 'file=@bundle.zip'

GET/bundles/{bundle_id}

Consulta ou marca um bundle como removido.

URL completa: https://api.aifoxapp.com/api/v1/bundles/{bundle_id}
Acesso: JWT ou API key
Entradas: bundle_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/bundles/{bundle_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

DELETE/bundles/{bundle_id}

Consulta ou marca um bundle como removido.

URL completa: https://api.aifoxapp.com/api/v1/bundles/{bundle_id}
Acesso: JWT ou API key
Entradas: bundle_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/bundles/{bundle_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Channels

GET/channels/app/{app_id}

Lista ou cria canais de distribuição.

URL completa: https://api.aifoxapp.com/api/v1/channels/app/{app_id}
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/channels/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/channels/app/{app_id}

Lista ou cria canais de distribuição.

URL completa: https://api.aifoxapp.com/api/v1/channels/app/{app_id}
Acesso: JWT
Entradas: app_id; name, slug, public=false, ios=true, android=true
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/channels/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/channels/{channel_id}

Consulta, atualiza ou exclui um canal.

URL completa: https://api.aifoxapp.com/api/v1/channels/{channel_id}
Acesso: JWT
Entradas: channel_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/channels/{channel_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

PUT/channels/{channel_id}

Consulta, atualiza ou exclui um canal.

URL completa: https://api.aifoxapp.com/api/v1/channels/{channel_id}
Acesso: JWT
Entradas: channel_id; name?, current_bundle_id?, secondary_bundle_id?, public?, rollout_percentage? (0–100)
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X PUT 'https://api.aifoxapp.com/api/v1/channels/{channel_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

DELETE/channels/{channel_id}

Consulta, atualiza ou exclui um canal.

URL completa: https://api.aifoxapp.com/api/v1/channels/{channel_id}
Acesso: JWT
Entradas: channel_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/channels/{channel_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/channels/{channel_id}/promote/{bundle_id}

Promove um bundle e preserva a versão anterior.

URL completa: https://api.aifoxapp.com/api/v1/channels/{channel_id}/promote/{bundle_id}
Acesso: JWT
Entradas: channel_id, bundle_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/channels/{channel_id}/promote/{bundle_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/channels/{channel_id}/rollback

Troca o bundle atual pelo bundle anterior.

URL completa: https://api.aifoxapp.com/api/v1/channels/{channel_id}/rollback
Acesso: JWT
Entradas: channel_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/channels/{channel_id}/rollback' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Devices

GET/devices/app/{app_id}

Lista dispositivos do app.

URL completa: https://api.aifoxapp.com/api/v1/devices/app/{app_id}
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/devices/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/devices/app/{app_id}/register

Registra ou atualiza um dispositivo.

URL completa: https://api.aifoxapp.com/api/v1/devices/app/{app_id}/register
Acesso: JWT
Entradas: app_id; device_id, platform=android, push_token?, push_provider?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/devices/app/{app_id}/register' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/devices/{device_id}/channel

Associa o dispositivo a um canal.

URL completa: https://api.aifoxapp.com/api/v1/devices/{device_id}/channel
Acesso: JWT
Entradas: device_id, channel_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/devices/{device_id}/channel' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Updates

POST/updates/check

Verifica se há atualização OTA para o cliente do app.

URL completa: https://api.aifoxapp.com/api/v1/updates/check
Acesso: Cliente do app
Entradas: device_id, app_id, version, platform, os_version?, plugin_version?, channel?, custom_id?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/check' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/updates/downloaded

Registra o download de um bundle.

URL completa: https://api.aifoxapp.com/api/v1/updates/downloaded
Acesso: Cliente do app
Entradas: query: device_id, bundle_version, app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/downloaded' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/updates/installed

Registra a instalação de um bundle.

URL completa: https://api.aifoxapp.com/api/v1/updates/installed
Acesso: Cliente do app
Entradas: query: device_id, bundle_version, app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/installed' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/updates/failed

Registra uma falha de atualização.

URL completa: https://api.aifoxapp.com/api/v1/updates/failed
Acesso: Cliente do app
Entradas: query: device_id, bundle_version, app_id, error?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/failed' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/updates/bundle/{app_id}/{version}.zip

Baixa um bundle por URL assinada e não expirada.

URL completa: https://api.aifoxapp.com/api/v1/updates/bundle/{app_id}/{version}.zip
Acesso: URL assinada
Entradas: app_id, version; query: exp, sig
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/updates/bundle/{app_id}/{version}.zip' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Manifests

GET/manifests/app/{app_id}

Lista ou cria versões imutáveis de manifesto.

URL completa: https://api.aifoxapp.com/api/v1/manifests/app/{app_id}
Acesso: JWT ou API key
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/manifests/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/manifests/app/{app_id}

Lista ou cria versões imutáveis de manifesto.

URL completa: https://api.aifoxapp.com/api/v1/manifests/app/{app_id}
Acesso: JWT ou API key
Entradas: app_id; chassis=chassi1, data (requires app_name and primary_color)
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/manifests/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Modules

GET/module-runtime/registry/v2

Lista schemas, fases e planos mínimos dos módulos.

URL completa: https://api.aifoxapp.com/api/v1/module-runtime/registry/v2
Acesso: Público
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/registry/v2' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/module-runtime/public/{package_name}/config

Retorna a configuração pública sanitizada dos módulos.

URL completa: https://api.aifoxapp.com/api/v1/module-runtime/public/{package_name}/config
Acesso: Público
Entradas: package_name
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/public/{package_name}/config' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/module-runtime/custom-modules/v1

Lista extensões declarativas curadas com hash de integridade.

URL completa: https://api.aifoxapp.com/api/v1/module-runtime/custom-modules/v1
Acesso: Público
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/custom-modules/v1' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/module-runtime/app/{app_id}/config

Consulta ou atualiza a configuração administrativa dos módulos.

URL completa: https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

PUT/module-runtime/app/{app_id}/config

Consulta ou atualiza a configuração administrativa dos módulos.

URL completa: https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config
Acesso: JWT
Entradas: app_id; modules[]
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X PUT 'https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/module-runtime/app/{app_id}/publish

Publica a próxima versão do manifesto.

URL completa: https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/publish
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/publish' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Content

GET/content/public/{package_name}/rss

Retorna um feed RSS ou Atom validado e normalizado.

URL completa: https://api.aifoxapp.com/api/v1/content/public/{package_name}/rss
Acesso: Público
Entradas: package_name
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/content/public/{package_name}/rss' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Commerce

GET/commerce/app/{app_id}/integrations

Retorna o estado sanitizado dos conectores.

URL completa: https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/integrations
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/integrations' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/commerce/app/{app_id}/shopify/sync

Sincroniza um catálogo Shopify já provisionado.

URL completa: https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/shopify/sync
Acesso: JWT
Entradas: app_id; limit?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/shopify/sync' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Purchases

POST/purchases/public/{package_name}/verify

Valida uma compra da loja no servidor para o membro autenticado.

URL completa: https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/verify
Acesso: Cliente do app
Entradas: platform, product_id, product_type, purchase_token, environment?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/verify' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/purchases/public/{package_name}/entitlements

Lista os acessos ativos do membro autenticado.

URL completa: https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/entitlements
Acesso: Cliente do app
Entradas: package_name
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/entitlements' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Intelligence

POST/intelligence/public/{package_name}/assistant

Responde com base no contexto publicado do app.

URL completa: https://api.aifoxapp.com/api/v1/intelligence/public/{package_name}/assistant
Acesso: Público
Entradas: question
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/intelligence/public/{package_name}/assistant' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/intelligence/app/{app_id}/autofill

Retorna sugestão administrativa sem aplicá-la.

URL completa: https://api.aifoxapp.com/api/v1/intelligence/app/{app_id}/autofill
Acesso: JWT
Entradas: app_id; module_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/intelligence/app/{app_id}/autofill' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Builds

GET/builds/app/{app_id}

Lista os últimos 50 builds do app.

URL completa: https://api.aifoxapp.com/api/v1/builds/app/{app_id}
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/builds/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/builds/app/{app_id}/android

Enfileira um build Android.

URL completa: https://api.aifoxapp.com/api/v1/builds/app/{app_id}/android
Acesso: JWT ou API key
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/builds/app/{app_id}/android' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/builds/app/{app_id}/ios

Enfileira um build iOS com o provedor configurado.

URL completa: https://api.aifoxapp.com/api/v1/builds/app/{app_id}/ios
Acesso: JWT ou API key
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/builds/app/{app_id}/ios' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/builds/{build_id}

Retorna um build.

URL completa: https://api.aifoxapp.com/api/v1/builds/{build_id}
Acesso: JWT ou API key
Entradas: build_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/builds/{build_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Preview

POST/preview/generate

Gera uma sessão pública de preview com limite de taxa.

URL completa: https://api.aifoxapp.com/api/v1/preview/generate
Acesso: Público
Entradas: business? or site_url?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/preview/generate' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/preview/{session_id}

Retorna uma sessão de preview ativa.

URL completa: https://api.aifoxapp.com/api/v1/preview/{session_id}
Acesso: Público
Entradas: session_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/preview/{session_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Consultor

POST/consultor/chat

Envia uma mensagem ao consultor público.

URL completa: https://api.aifoxapp.com/api/v1/consultor/chat
Acesso: Público
Entradas: messages; business?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/consultor/chat' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Billing

GET/billing/plan

Retorna o plano e seu status.

URL completa: https://api.aifoxapp.com/api/v1/billing/plan
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/billing/plan' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/billing/checkout

Cria uma sessão de Checkout para assinatura.

URL completa: https://api.aifoxapp.com/api/v1/billing/checkout
Acesso: JWT
Entradas: plan: essencial | profissional | loja | enterprise
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/billing/checkout' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/billing/wallet

Retorna saldo e os últimos 20 lançamentos.

URL completa: https://api.aifoxapp.com/api/v1/billing/wallet
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/billing/wallet' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/billing/topup

Cria um Checkout para o pacote fixo de créditos.

URL completa: https://api.aifoxapp.com/api/v1/billing/topup
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/billing/topup' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

API keys

GET/api-keys/

Lista ou cria chaves de API.

URL completa: https://api.aifoxapp.com/api/v1/api-keys/
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/api-keys/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/api-keys/

Lista ou cria chaves de API.

URL completa: https://api.aifoxapp.com/api/v1/api-keys/
Acesso: JWT
Entradas: name?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/api-keys/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

DELETE/api-keys/{key_id}

Revoga uma chave de API.

URL completa: https://api.aifoxapp.com/api/v1/api-keys/{key_id}
Acesso: JWT
Entradas: key_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/api-keys/{key_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Reseller

GET/reseller/children

Lista ou cria sub-organizações.

URL completa: https://api.aifoxapp.com/api/v1/reseller/children
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/reseller/children' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/reseller/children

Lista ou cria sub-organizações.

URL completa: https://api.aifoxapp.com/api/v1/reseller/children
Acesso: JWT de owner
Entradas: name, slug
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/reseller/children' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

PUT/reseller/branding

Atualiza o branding da organização revendedora.

URL completa: https://api.aifoxapp.com/api/v1/reseller/branding
Acesso: JWT de owner
Entradas: branding (object)
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X PUT 'https://api.aifoxapp.com/api/v1/reseller/branding' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Notifications

POST/notifications/app/{app_id}/send

Envia push aos dispositivos correspondentes.

URL completa: https://api.aifoxapp.com/api/v1/notifications/app/{app_id}/send
Acesso: JWT
Entradas: app_id; title, body, channel_id?
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/notifications/app/{app_id}/send' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Migration

POST/migration/importar_do_github

Importa uma configuração de CI reconhecida do GitHub.

URL completa: https://api.aifoxapp.com/api/v1/migration/importar_do_github
Acesso: JWT
Entradas: repo_url
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X POST 'https://api.aifoxapp.com/api/v1/migration/importar_do_github' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Stats

GET/stats/dashboard

Retorna estatísticas do painel da organização.

URL completa: https://api.aifoxapp.com/api/v1/stats/dashboard
Acesso: JWT
Entradas: —
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/stats/dashboard' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/stats/app/{app_id}

Retorna estatísticas de um app.

URL completa: https://api.aifoxapp.com/api/v1/stats/app/{app_id}
Acesso: JWT
Entradas: app_id
Resposta: 200/201: resultado da operação em JSON. O formato exato segue o recurso retornado por este handler.
Erros: Erros comuns: 401, 403, 404, 422, 429 e 503, conforme a operação.

curl -X GET 'https://api.aifoxapp.com/api/v1/stats/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Não público: POST /builds/ci-callback e POST /billing/webhook são integrações internas e não devem ser chamados por clientes.