O que é uma API?
Uma API (“Application Programming Interface“) é uma forma de permitir a integração entre duas aplicações diferentes. Por meio das integrações feitas via API, estas aplicações diferentes podem trocar informações e fazer atualizações. Na prática, significa dar a possibilidade de você conectar o seu sistema próprio (seu app, seu site, etc.) diretamente com o sistema da APOIA.se, permitindo, por exemplo, gerenciar sua entrega de conteúdos em seu espaço próprio e, ao mesmo tempo, manter o processo de cobrança de seus apoiadores(as) dentro da APOIA.se.
Como funciona a API da APOIA.se?
A maior solicitação de nossa comunidade sempre foi a de saber facilmente se determinado usuário do próprio sistema é um apoiador ativo de uma campanha ou não.
Isso possibilita aos Fazedores(as) saberem se podem permitir que um apoiador acesse determinados conteúdos em seus sistemas externos próprios, como aplicativos, sites, etc..
A consulta a API permite saber se a pessoa é um apoiador da sua campanha, qual valor do apoio e se o apoio do mês atual foi pago ou não. Se você, por exemplo, tem uma área em seu site que apenas apoiadores em dia podem acessar... Bom, a nossa API está aqui para ajudar você nessa tarefa.
Como utilizar a API da APOIA.se?
A API da APOIA.se é pública e você Fazedor ou Fazedora da nossa plataforma pode utilizá-la para auxiliar no gerenciamento da sua campanha.
- Acesse a documentação: A APOIA.se disponibiliza a documentação da API que detalha alguns pontos importantes para sua implementação.
- Solicite sua chave de autenticação da API: Além de consultar a documentação, você precisará de uma chave de autenticação que deve ser solicitada na Central de Suporte. O "colaborador" da campanha pode requisitar a chave API, mas o envio será realizado para o e-mail principal da campanha.
Sabemos que diferentes necessidades podem aparecer e caso haja outras dúvidas entre em contato conosco pela Central de Suporte.