Central Fox Tecnologia LTDA Affiliates API
The affiliates API from Central Fox Tecnologia LTDA — 2 operation(s) for affiliates.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/foxnfe-com-br:foxnfe-com-br-affiliates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FOX NF-e Affiliates API
version: '1.20260923'
description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: Affiliates
paths:
/api/v1/affiliates:
get:
operationId: get_api_v1_affiliates
tags:
- Affiliates
summary: Affiliate index
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:45
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
referrals:
type: array
items:
type: object
properties:
id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:55
referral_code:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:56
referred_email:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:57
status:
type: string
enum:
- draft
- pending
- processing
- authorized
- rejected
- denied
- canceled
- contingency
x-source: app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php
converted_at:
type:
- string
- 'null'
format: date-time
commissions:
type: array
items:
type: object
properties:
id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:62
referral_id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:63
amount_cents:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:64
status:
type: string
enum:
- draft
- pending
- processing
- authorized
- rejected
- denied
- canceled
- contingency
x-source: app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php
accrued_at:
type: string
format: date-time
reversed_at:
type:
- string
- 'null'
format: date-time
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data:
referrals:
- id: null
referral_code: null
referred_email: null
status: draft
commissions:
- id: null
referral_id: null
amount_cents: null
status: draft
x-source:
- app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:52
security:
- bearerAuth: []
/api/v1/affiliates/referrals:
post:
operationId: post_api_v1_affiliates_referrals
tags:
- Affiliates
summary: Affiliate store
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:21
x-middleware:
- api
- auth:sanctum
- agent.provider
- tenant.identify
- tenant.status
- throttle:20,60
responses:
'409':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: referral_duplicate
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: referral_duplicate
message: EXEMPLO_FICTICIO
x-source:
- app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:34
'201':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:38
referral_code:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:39
referred_email:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:40
status:
type: string
enum:
- draft
- pending
- processing
- authorized
- rejected
- denied
- canceled
- contingency
x-source: app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
data:
id: null
referral_code: null
referred_email: null
status: draft
x-source:
- app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:37
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_affiliates_referralsRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
referred_email: integracao@example.invalid
components:
schemas:
post_api_v1_affiliates_referralsRequest:
type: object
properties:
referred_email:
x-laravel-rules:
- required
- email
- max:255
type: string
format: email
maxLength: 255
required:
- referred_email
x-source:
- app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:23
securitySchemes:
bearerAuth:
type: http
scheme: bearer