A instalação da PolenAPI é feita de forma simples conforme os passos descritos a seguir.

Requisitos

• Versão do NodeJS: Deve ser igual a 12 ou superior (que pode ser verificado executando node --version).
• Gerenciador de pacotes NPM ou Yarn.

Instalação

A maneira mais fácil de instalar a PolenAPI é usar a ferramenta de linha de comando. Você pode executar este comando em qualquer lugar em um novo repositório ou dentro de um repositório existente. Você pode encontrar essa e várias outras bibliotecas em nossos repositórios.

npm install polencharitydonationapi

Como usar

Após a instalação você pode fazer a importação para o seu projeto através do import e fazer uma instância da classe PolenCharityDonationAPI passando um token de acesso. Esse token pode ser encontrado no painel do polinizador.

import PolenCharityDonationAPI from "PolenCharityDonationAPI";

const polen = PolenCharityDonationAPI("token");

Como conseguir o seu Token

Acesse sua conta no nosso painel ou crie uma nova conta. Após acessar vá no menu do canto superior direito, clique em API e depois é só copiar o conteúdo do campo Token.

Métodos

Você pode consultar nossa documentação e verificar todos os métodos disponíveis.

• Causes: Métodos que permitem consultas de causas;
• Company: Métodos que listam empresas, criam empresas, atualizam dados da empresa e listam lojas associadas a uma empresa;
• Donation Direct: Método que cria uma doação direta;
• Finance: Método que retorna todas as suas faturas de pagamento;
• Donation Notify: Métodos que listam doações feitas, retornam detalhes de uma doação, atualizam status de uma doação e criam uma nova doação associada a uma loja;
• Platform: Método que retorna todas as plataformas parceiras que o Polen já possui integração nativa;
• Store: Métodos que listam lojas, criam novas lojas, editam lojas existentes e adicionam/removem causas da loja;
• Transaction: Método para o informar o estado de uma compra;
• Transparency: Métodos que permitem a consulta de listas de conteúdos disponibilizados pelas ongs, detalhes de um conteúdo, recibos de doações e um considado do total doado;
• User: Métodos que permitem a consulta de detalhes de um usuário, lista de usuários de uma loja, criar usuários, deletar usuários, associar usuários a causas;

Ajuda

• Acesse nossa documentação e conheça melhor nossa lib.

• Ainda com dúvida? Entre em contato pelo nosso canal do discord, vamos ter o prazer de ajudar você!