API do ClickBank

Observe que a API do ClickBank é para uso por aqueles com experiência significativa em desenvolvimento.

A API do ClickBank possibilita uma ampla gama de programas de computador para acessar com segurança as informações da conta do ClickBank, em nome dos proprietários da conta do ClickBank. Algumas das funções disponíveis a usuários da API incluem o recurso para:

  • Pedir um reembolso de uma compra de consumidor
  • Pedir um cancelamento da assinatura de um consumidor
  • Recuperar uma lista de transações em uma conta do ClickBank para um determinado período de tempo

As possibilidades para programas que fazem uso da API do ClickBank são muitas e incluem: um painel que mostra os dados do ClickBank além dos dados de contas com outros serviços on-line, uma ferramenta de gerenciamento de assinatura, e um pacote de analíticas que mostram dados sobre tendências em vendas para uma conta em particular do ClickBank. Todas essas aplicações e outras são possíveis com a API do ClickBank. Além disso, elas podem também ser vendidas no Mercado do ClickBank!

A API do serviço do ClickBank está elaborada em uma arquitetura REST e fornece um mecanismo baseado em http confiável e seguro para recuperar dados.

REST

O REST é um estilo de arquitetura lançado por Roy Fielding, que foi um dos principais autores do protocolo HTTP em sua dissertação- "Estilos arquitetônicos e o desenho de arquiteturas de software baseadas em rede." Uma breve introdução ao REST pode ser encontrada no artigo da Wikipedia Representational State Transfer

Versões

A versão atual da API do Serviço do ClickBank é: 1.3.

A informação da versão é parte do URL para acessar os serviços. Isso fornece os seguintes benefícios:

  • Limpar informações sobre qual versão da API está sendo usada
  • Uma forma fácil para compreender o caminho de atualização quando novas versões da API são anunciadas

Infraestrutura

A API REST do ClickBank é baseada em JSR-311 - A API Java para serviços da Web RESTful. Isso é um detalhe de implementação para a API de serviço do ClickBank. Os serviços em si são baseados em HTTP e agnósticos de implementação; assim, qualquer cliente web (.NET, PHP, Java, Python, Ruby, etc) pode utilizar os serviços.

Embora o ClickBank não endosse qualquer ferramenta REST para desenvolvimento, consideramos realmente RestClient ser muito útil durante o desenvolvimento e testes dos serviços da web RESTful.

Solicitar cabeçalho

O Cabeçalho da API do serviço do ClickBank consiste de segurança, resultado e parâmetros de página. A API do serviço do ClickBank aceita parâmetros de consulta; solicitações incorporadas baseada em parâmetros (publicação) são ignoradas.

O spec de HTTP indica que um URL não pode ter mais de 2k de comprimento. Os desenvolvedores de API devem garantir que o comprimento da API sobre url seja menor do que 2.000 caracteres.

Certificação

Com algumas linguagens de programação a API de serviço do ClickBank irá necessitar que seu sistema tenha um certificado para o seguinte domínio:

*.clickbank.com

Para adquirir o certificado, simplesmente vá para o URL a seguir, clique duas vezes no cadeado de autenticação no canto inferior direito de seu navegador e salve o certificado em seu sistema

https://api.clickbank.com/rest/1.3/orders

Segurança

Os métodos da API de serviço do ClickBank são seguros e retornarão um código de status 403 [Proibido] se acessados sem as credenciais corretas. O acesso seguro à API requer um parâmetro de cabeçalho de Autorização contendo as seguintes chaves:

  • Chave de desenvolvedor - A chave de desenvolvedor concede ao usuário o papel "ROLE_HAS_DEVELOPER_KEY".
  • Chave de usuário administrativo - A chave de usuário administrativo concede ao usuário o "ROLE_API_ORDER_READ" ou "ROLE_API_ORDER_WRITE".

Em termos conceituais, uma chave de desenvolvedor é um token que é usado de forma geral para permitir acesso às APIs; enquanto uma chave de API de usuário administrativo seja associada de forma geral a um usuário em particular.  Ao criar um parâmetro de cabeçalho com ambos os papéis, cada valor deverá ser separado por dois pontos.

Exemplo:

Autorização DEV-F7F8023A486E9A9602FFDA2765E1925:API-9870acb8d96f8bd18c2eb70725b01fe4b98ece58

Algumas das APIs do serviço do ClickBank (principalmente a sandbox) não requerem ambas as chaves. A documentação de API suportada lista os papéis necessários para acessar um serviço em particular. Se apenas a chave do desenvolvedor for necessária, um sinal de dois pontos no parâmetro do cabeçalho não será necessário.

Exemplo:

Autorização DEV-F7F8023A486E9A9602FFDA2765E1925

Para adquirir as chaves de Desenvolvedor e de Usuário administrativo, consulte nosso artigo sobre usar uma Conta mestre do ClickBank. Cada chave deve ser aprovada, presente e ativa para que ocorra uma autenticação de sucesso.

Resultado

A API de serviço do ClickBank suporta os seguintes formatos de resultado:

  • XML
  • JSON
  • CSV (funciona apenas com a API de pedidos)

Solicite o formato de resultado incluindo um parâmetro Aceitar  no cabeçalho de http. Se um formato não suportado for solicitado, o servidor fornecerá um código de status 500 [Erro Interno do Servidor].

Exemplo:

Aceitar aplicativo/xml

Paginação

A API nunca retornará mais do que 100 linhas para qualquer chamada de serviço. Para pedidos que contenham mais de 100 linhas de dados, a API retornará as primeiras 100 linhas com um código de status de 206 [Conteúdo parcial]. Para recuperar as páginas adicionais, o desenvolvedor deve incluir um parâmetro de cabeçalho de Página indicando qual página do resultado é desejada.

Exemplo:

Página 3

Após a última página ser acessada, o serviço retornará um 200 [OK] ao invés de um 206 [conteúdo parcial].

Limitações de API do ClickBank

a API do ClickBank controla um grande número de operações. Para proteger o sistema contra o recebimento de mais operações do que pode controlar, e para assegurar uma distribuição equitativa de recursos do sistema, é necessário empregar um sistema de cotas. Nossas políticas são as seguintes e em suporte dos Termos de serviço da API. Nota: Os Termos estão sujeitos à alteração.

Todos os aplicativos em um único projeto compartilham todos os limites por projeto.

Cotas de API gerais:

•        25.000 solicitações por conta por dia
•        10 consultas por segundo (QPS) por IP

Se a cota for ultrapassada, a API do ClickBank retornará um erro para solicitações adicionais: Status HTTP código 403 Proibido e uma mensagem indicando que a conta específica tem cota insuficiente para continuar.

APIs suportadas

Para a versão 1.3, as seguintes APIs serão suportadas:

Cada API do ClickBank é auto-descritiva. Para detalhes de descrição do serviço, simplesmente acesse a API URL.

Ferramentas adicionais

Debugging

A API do ClickBank fornece um serviço da web de debug [/rest/1.3/debug]. O serviço imprime as informações de contexto de pedido (incluindo as informações de contexto de segurança), o que pode ser muito útil ao corrigir problemas de REST API.

Amostras de códigos

As amostras de código a seguir demonstram como um desenvolvedor pode utilizar as APIs:

Tem mais dúvidas? Envie uma solicitação

0 Comentários

Por favor, entre para comentar.
Powered by Zendesk