Criar Afiliado

curl --request POST \
  --url https://api.affiliatus.io/v1/affiliates \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "referralId": "<string>"
}
'

import requests

url = "https://api.affiliatus.io/v1/affiliates"

payload = {
    "email": "<string>",
    "password": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "referralId": "<string>"
}
headers = {
    "X-API-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    password: '<string>',
    name: '<string>',
    phone: '<string>',
    referralId: '<string>'
  })
};

fetch('https://api.affiliatus.io/v1/affiliates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.affiliatus.io/v1/affiliates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'password' => '<string>',
    'name' => '<string>',
    'phone' => '<string>',
    'referralId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.affiliatus.io/v1/affiliates"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"referralId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.affiliatus.io/v1/affiliates")
  .header("X-API-Key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"referralId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.affiliatus.io/v1/affiliates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"referralId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "referralId": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "totalConversions": 123,
  "totalCommissions": 123,
  "totalPaid": 123
}

POST

affiliates

Criar Afiliado

curl --request POST \
  --url https://api.affiliatus.io/v1/affiliates \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "referralId": "<string>"
}
'

import requests

url = "https://api.affiliatus.io/v1/affiliates"

payload = {
    "email": "<string>",
    "password": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "referralId": "<string>"
}
headers = {
    "X-API-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    password: '<string>',
    name: '<string>',
    phone: '<string>',
    referralId: '<string>'
  })
};

fetch('https://api.affiliatus.io/v1/affiliates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.affiliatus.io/v1/affiliates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'password' => '<string>',
    'name' => '<string>',
    'phone' => '<string>',
    'referralId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.affiliatus.io/v1/affiliates"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"referralId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.affiliatus.io/v1/affiliates")
  .header("X-API-Key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"referralId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.affiliatus.io/v1/affiliates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"referralId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "referralId": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "totalConversions": 123,
  "totalCommissions": 123,
  "totalPaid": 123
}

Endpoint

POST https://api.affiliatus.io/v1/affiliates

Este endpoint permite criar um novo afiliado associado à campanha da sua API Key.

Auto-geração de Referral ID: Se você não fornecer um referralId, o sistema gerará automaticamente um código único de 8 caracteres alfanuméricos.

Autenticação

string

required

Sua API key obtida no dashboard em Configurações → API Keys

Body Parameters

string

required

E-mail do afiliado. Deve ser único dentro da campanha.

string

required

Senha para o afiliado acessar o portal. Mínimo de 6 caracteres.

string

Nome completo do afiliado

string

Telefone de contato do afiliado

string

Código de referência único para rastreamento. Se não fornecido, será gerado automaticamente.Regras:

Deve ser único globalmente (não apenas na campanha)
Alfanumérico (A-Z, 0-9)
Recomendado: 4-12 caracteres

Response

number

ID único do afiliado criado

string

Nome do afiliado

string

E-mail do afiliado

string

Telefone do afiliado

string

Código de referência único

string

Status do afiliado (pending, active ou inactive)

string

Data de criação (ISO 8601)

number

Número total de conversões (sempre 0 para novos afiliados)

number

Valor total de comissões em BRL

number

Valor total já pago ao afiliado em BRL

Exemplos

Criar Afiliado Completo

curl -X POST https://api.affiliatus.io/v1/affiliates \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sua_api_key_aqui" \
  -d '{
    "name": "João Silva",
    "email": "joao@example.com",
    "phone": "+55 11 99999-9999",
    "referralId": "JOAO123",
    "password": "senha_segura_123"
  }'

const response = await fetch('https://api.affiliatus.io/v1/affiliates', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.AFFILIATUS_API_KEY,
  },
  body: JSON.stringify({
    name: 'João Silva',
    email: 'joao@example.com',
    phone: '+55 11 99999-9999',
    referralId: 'JOAO123',
    password: 'senha_segura_123'
  })
});

const affiliate = await response.json();
console.log(affiliate);

import requests

response = requests.post(
    'https://api.affiliatus.io/v1/affiliates',
    headers={
        'Content-Type': 'application/json',
        'X-API-Key': 'sua_api_key_aqui',
    },
    json={
        'name': 'João Silva',
        'email': 'joao@example.com',
        'phone': '+55 11 99999-9999',
        'referralId': 'JOAO123',
        'password': 'senha_segura_123'
    }
)

affiliate = response.json()
print(affiliate)

<?php
$ch = curl_init('https://api.affiliatus.io/v1/affiliates');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-API-Key: sua_api_key_aqui'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'name' => 'João Silva',
    'email' => 'joao@example.com',
    'phone' => '+55 11 99999-9999',
    'referralId' => 'JOAO123',
    'password' => 'senha_segura_123'
]));

$response = curl_exec($ch);
curl_close($ch);

$affiliate = json_decode($response, true);
print_r($affiliate);

Resposta de Sucesso (201 Created)

{
  "id": 123,
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "+55 11 99999-9999",
  "referralId": "JOAO123",
  "status": "active",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "totalConversions": 0,
  "totalCommissions": 0,
  "totalPaid": 0
}

Criar Afiliado Mínimo (Auto-gerar Referral ID)

curl -X POST https://api.affiliatus.io/v1/affiliates \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sua_api_key_aqui" \
  -d '{
    "email": "maria@example.com",
    "password": "senha123"
  }'

const response = await fetch('https://api.affiliatus.io/v1/affiliates', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.AFFILIATUS_API_KEY,
  },
  body: JSON.stringify({
    email: 'maria@example.com',
    password: 'senha123'
  })
});

const affiliate = await response.json();
console.log('Referral ID gerado:', affiliate.referralId);

Resposta de Sucesso (Referral ID gerado)

{
  "id": 124,
  "email": "maria@example.com",
  "referralId": "A7K9M2X5",
  "status": "active",
  "createdAt": "2024-01-15T10:35:00.000Z",
  "totalConversions": 0,
  "totalCommissions": 0,
  "totalPaid": 0
}

Erros

400 - Dados Inválidos

{
  "statusCode": 400,
  "message": [
    "email must be a valid email",
    "password must be at least 6 characters long"
  ],
  "error": "Bad Request"
}

Solução: Corrija os dados conforme as mensagens de erro.

401 - API Key Inválida

{
  "statusCode": 401,
  "message": "Invalid or inactive API Key",
  "error": "Unauthorized"
}

Solução: Verifique se o header X-API-Key está correto e se a chave está ativa.

403 - Limite Excedido

{
  "statusCode": 403,
  "message": "Affiliate limit exceeded: Affiliate limit reached for starter plan. Current: 50/50",
  "error": "Forbidden"
}

Solução: Faça upgrade do seu plano ou remova afiliados inativos.

409 - E-mail ou Referral ID Não Disponível

{
  "statusCode": 409,
  "message": "Email is not available",
  "error": "Conflict"
}

{
  "statusCode": 409,
  "message": "Referral ID is not available",
  "error": "Conflict"
}

Solução: Use um e-mail ou referralId diferente.

Segurança: As mensagens não revelam se o conflito é dentro da sua campanha ou em outra campanha.

429 - Rate Limit

{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests",
  "error": "Too Many Requests"
}

Solução: Aguarde 60 segundos antes de tentar novamente.

Validações

E-mail

Obrigatório
Deve ser um e-mail válido
Único por campanha

Senha

Obrigatória
Mínimo de 6 caracteres
Será armazenada com hash bcrypt (segura)

Referral ID

Opcional (auto-gerado se não fornecido)
Único globalmente
Alfanumérico (A-Z, 0-9)
Case-insensitive para validação

Nome e Telefone

Opcionais
Podem ser atualizados posteriormente

Próximos Passos

Listar Afiliados

Consulte todos os afiliados criados

Enviar Conversões

Rastreie conversões dos afiliados

Atualizar Afiliado

Edite informações do afiliado

Dashboard

Visualize no dashboard

Visão Geral

Eventos

Afiliados

Criar Afiliado

Endpoint

Autenticação

Body Parameters

Response

Exemplos

Criar Afiliado Completo

Resposta de Sucesso (201 Created)

Criar Afiliado Mínimo (Auto-gerar Referral ID)

Resposta de Sucesso (Referral ID gerado)

Erros

400 - Dados Inválidos

401 - API Key Inválida

403 - Limite Excedido

409 - E-mail ou Referral ID Não Disponível

429 - Rate Limit

Validações

Próximos Passos

Listar Afiliados

Enviar Conversões

Atualizar Afiliado

Dashboard

​Endpoint

​Autenticação

​Body Parameters

​Response

​Exemplos

​Criar Afiliado Completo

​Resposta de Sucesso (201 Created)

​Criar Afiliado Mínimo (Auto-gerar Referral ID)

​Resposta de Sucesso (Referral ID gerado)

​Erros

​400 - Dados Inválidos

​401 - API Key Inválida

​403 - Limite Excedido

​409 - E-mail ou Referral ID Não Disponível

​429 - Rate Limit

​Validações

​Próximos Passos

Listar Afiliados

Enviar Conversões

Atualizar Afiliado

Dashboard

Endpoint

Autenticação

Body Parameters

Response

Exemplos

Criar Afiliado Completo

Resposta de Sucesso (201 Created)

Criar Afiliado Mínimo (Auto-gerar Referral ID)

Resposta de Sucesso (Referral ID gerado)

Erros

400 - Dados Inválidos

401 - API Key Inválida

403 - Limite Excedido

409 - E-mail ou Referral ID Não Disponível

429 - Rate Limit

Validações

Próximos Passos