Documentação da API do Monetizzy

Documentação completa da API Monetizzy para integração de encurtamento e monetização de links em suas aplicações.

Índice da Documentação

1. Autenticação (/api/auth)

POST GET

Descrição: Endpoint utilizado para autenticar um usuário e obter um token de acesso para as operações subsequentes.

Parâmetros:

key (string): Nome de usuário do cliente.

Exemplo de Requisição:

curl -X POST https://monetizzy.com/api/auth \
  -H "Content-Type: application/json" \
  -d '{"key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}'

Exemplo de Resposta:

{
  "authentication": {
    "code": "NCXxhmZ8ropSWzDf5wUiYO",
    "status": "✅ success",
    "description": "The key was successfully authenticated.",
    "user": {
      "id": "166235",
      "username": "johndoe"
    }
  }
}

POST

Descrição: Endpoint utilizado para criar um novo link encurtado associado ao usuário autenticado.

Parâmetros:

  • link(string): URL que será encurtada.

Cabeçalho:

  • key (string): Token de acesso obtido na autenticação.

Exemplo de Requisição:

curl -X POST https://monetizzy.com/api/shorten/link \
  -H "Content-Type: application/json" \
  -d '{"key": "xxxxxxxxxxxxxxxxxxxxxxx", "link": "https://www.exemplo.com", "domain": "ufly.monetizzy.com", "type": 4}'

Exemplo de Resposta:

{
  "authentication": {
    "code": "NCXxhmZ8ropSWzDf5wUiYO",
    "status": "✅ success",
    "description": "The key was successfully authenticated.",
    "user": {
      "id": "166235",
      "username": "johndoe"
    }
  },
  "shorten": {
    "code": "t3sTjGk4XKTPBIqKB70sa7",
    "status": "✅ success",
    "description": "The link has been shortened.",
    "link": "https://example1.com/aFtguIfIbPAv7321"
  }
}

3. Lista de Domínios (/api/domains/list)

GET

Descrição: Endpoint utilizado para obter a lista de domínios disponíveis para encurtar links, juntamente com seus IDs associados.

Cabeçalho:

  • key (string): Token de acesso obtido na autenticação.

Exemplo de Requisição:

curl -X POST https://monetizzy.com/api/domains/list \
  -H "Content-Type: application/json" \
  -d '{"key": "xxxxxxxxxxxxxxxxxxxxxxx"}'

Exemplo de Resposta:

{
  "authentication": {
    "code": "NCXxhmZ8ropSWzDf5wUiYO",
    "status": "✅ success",
    "description": "The key was successfully authenticated.",
    "user": {
      "id": "166235",
      "username": "johndoe"
    }
  },
  "domains": {
    "code": "EOr3FGZc3oqSw6VoqUGVyL",
    "status": "✅ success",
    "list": [
      [
        "172345",
        "example1.com"
      ],
      [
        "562451",
        "example2.com"
      ],
      [
        "934462",
        "example3.com"
      ]
    ]
  }
}

4. Uso do Proxy

Sobre o Proxy

O proxy.monetizzy.com foi criado para permitir requisições seguras para a API do Monetizzy, evitando problemas de CORS e melhorando a segurança das comunicações entre o front-end e os endpoints da API.

Benefícios do Proxy:

  • Permite chamadas para a API sem restrições de CORS.
  • Oculta a chave de API no servidor, aumentando a segurança.
  • Facilita a integração do Monetizzy com aplicações web.
Como usar o Proxy

Todas as requisições devem ser enviadas para https://proxy.monetizzy.com com a URL original e payload nos parâmetros.

Exemplo básico:

curl -X POST https://proxy.monetizzy.com \
  -H "Content-Type: application/json" \
  -d '{"url": "https://monetizzy.com/api/shorten/link", "payload": {"key": "xxxxxxxxxxxxxxxxxxxxxxx", "link": "https://www.exemplo.com", "domain": "ufly.monetizzy.com", "type": 4}}'

5. Autenticação via Proxy

POST GET

Descrição: Endpoint utilizado para autenticar um usuário e obter um token de acesso para as operações subsequentes.

Parâmetros:

key (string): Nome de usuário do cliente.

Exemplo de Requisição:

curl -X POST https://proxy.monetizzy.com \
  -H "Content-Type: application/json" \
  -d '{"url": "https://monetizzy.com/api/auth", "payload": {"key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}'

Exemplo de Resposta:

{
  "authentication": {
    "code": "NCXxhmZ8ropSWzDf5wUiYO",
    "status": "✅ success",
    "description": "The key was successfully authenticated.",
    "user": {
      "id": "166235",
      "username": "johndoe"
    }
  }
}

6. Encurtar Link via Proxy

POST

Descrição: Endpoint utilizado para criar um novo link encurtado associado ao usuário autenticado.

Parâmetros:

  • link(string): URL que será encurtada.

Cabeçalho:

  • key (string): Token de acesso obtido na autenticação.

Exemplo de Requisição:

curl -X POST https://proxy.monetizzy.com \
  -H "Content-Type: application/json" \
  -d '{"url": "https://monetizzy.com/api/shorten/link", "payload": {"key": "xxxxxxxxxxxxxxxxxxxxxxx", "link": "https://www.exemplo.com", "domain": "ufly.monetizzy.com", "type": 4}}'

Exemplo de Resposta:

{
  "authentication": {
    "code": "NCXxhmZ8ropSWzDf5wUiYO",
    "status": "✅ success",
    "description": "The key was successfully authenticated.",
    "user": {
      "id": "166235",
      "username": "johndoe"
    }
  },
  "shorten": {
    "code": "t3sTjGk4XKTPBIqKB70sa7",
    "status": "✅ success",
    "description": "The link has been shortened.",
    "link": "https://example1.com/aFtguIfIbPAv7321"
  }
}

7. Lista de Domínios via Proxy

GET

Descrição: Endpoint utilizado para obter a lista de domínios disponíveis para encurtar links, juntamente com seus IDs associados.

Cabeçalho:

  • key (string): Token de acesso obtido na autenticação.

Exemplo de Requisição:

curl -X POST https://proxy.monetizzy.com \
  -H "Content-Type: application/json" \
  -d '{"url": "https://monetizzy.com/api/domains/list", "payload": {"key": "xxxxxxxxxxxxxxxxxxxxxxx"}}'

Exemplo de Resposta:

{
  "authentication": {
    "code": "NCXxhmZ8ropSWzDf5wUiYO",
    "status": "✅ success",
    "description": "The key was successfully authenticated.",
    "user": {
      "id": "166235",
      "username": "johndoe"
    }
  },
  "domains": {
    "code": "EOr3FGZc3oqSw6VoqUGVyL",
    "status": "✅ success",
    "list": [
      [
        "172345",
        "example1.com"
      ],
      [
        "562451",
        "example2.com"
      ],
      [
        "934462",
        "example3.com"
      ]
    ]
  }
}
Pronto para Integrar?

Com esses endpoints você já pode integrar completamente a API do Monetizzy em sua aplicação. Use o proxy para requisições do front-end e a API direta para requisições do back-end!